CakePHP 文件夹结构
在这里,我们将了解 CakePHP 中的文件夹结构和命名约定,让我们从了解文件夹结构开始。
文件夹结构
下图显示了 CakePHP 的文件夹结构:
下表描述了 CakePHP 中各个文件夹的作用:
序号 | 文件夹名称和描述 |
---|---|
1 | bin bin文件夹包含 Cake 控制台可执行文件。 |
2 | config config文件夹包含 CakePHP 使用的(少数)配置文件,数据库连接详细信息、引导、核心配置文件等应存储在此处。 |
3 | logs logs文件夹通常包含你的日志文件,具体取决于你的日志配置。 |
4 | plugins plugins 文件夹是存储应用程序使用的插件的地方。 |
5 | resources 相应区域设置文件夹中的国际化文件将存储在此处。例如。语言环境/en_US。 |
6 | src src文件夹将是你施展魔法的地方,它是放置应用程序文件的地方,你将进行大部分应用程序开发,让我们仔细看看 src 中的文件夹。
|
7 | templates 模板展示文件放置在这里:元素、错误页面、布局和视图模板文件。 |
8 | tests tests文件夹将是你放置应用程序测试用例的地方。 |
9 | tmp tmp文件夹是 CakePHP 存储临时数据的地方,它存储的实际数据取决于你如何配置 CakePHP,但该文件夹通常用于存储模型描述,有时还用于存储会话信息。 |
10 | vendor vendor文件夹是安装 CakePHP 和其他应用程序依赖项的位置,必须注意不要编辑此文件夹中的文件。 |
11 | webroot webroot文件夹是应用程序的公共文档根目录,它包含你希望公开访问的所有文件。 |
命名约定
命名约定不是必须遵守的,但它是一种很好的编码实践,并且在你的项目变大时会非常有帮助。
控制器约定
控制器类的名字必须是复数,驼峰式命名且名字必须以Controller结尾。例如,对于学生类,控制器的名字可以是StudentsController。控制器的公共方法通常以 "actions "的形式暴露出来,可以通过网络浏览器访问。
例如,/users/view映射到UsersController的view()方法,受保护的或私有的方法不能通过路由访问。
文件和类名约定
大多数情况下,我们已经看到我们的类名文件名几乎相同,这在 cakephp 中是类似的。
例如,StudentsController 类的文件名为 StudentsController.php,这些文件必须保存为模块名称并保存在 app 文件夹中的相应文件夹中。
数据库约定
用于 CakePHP 模型的表,大多具有带下划线的复数名称。
例如,student_details、student_marks,如果字段名称由两个单词组成,则字段名称带有下划线,例如 first_name、last_name。
模型约定
对于模型,类按数据库表命名,名称为复数,驼峰式命名并以 Table 为后缀。
例如,StudentDetailsTable、StudentMarksTable。
视图约定
对于视图模板,文件基于控制器函数。
例如,如果 StudentDetailsController 类有函数 showAll(),则视图模板将命名为 show_all.php 并保存在 template/yrmodule/show_all.php 中。