CakePHP - 文件夹结构



在这里,我们将学习 CakePHP 中的文件夹结构和命名规范。让我们从了解文件夹结构开始。

文件夹结构

请查看以下屏幕截图。它显示了 CakePHP 的文件夹结构。

Structure of CakePHP

下表描述了 CakePHP 中每个文件夹的作用:

序号 文件夹名称及描述
1

bin

bin 文件夹包含 Cake 控制台可执行文件。

2

config

config 文件夹包含 CakePHP 使用的一些配置文件。数据库连接详细信息、引导程序、核心配置文件等都应存储在此处。

3

logs

logs 文件夹通常包含您的日志文件,具体取决于您的日志配置。

4

plugins

plugins 文件夹用于存储应用程序使用的插件。

5

resources

各个语言环境文件夹中的国际化文件将存储在此处。例如 locales/en_US。

6

src

src 文件夹是您施展魔法的地方。您的应用程序文件将放置在此处,您将在其中进行大部分应用程序开发。让我们更仔细地看看 src 内部文件夹。

  • Console - 包含应用程序的控制台命令和控制台任务。

  • Controller - 包含应用程序的控制器及其组件。

  • Model - 包含应用程序的表、实体和行为。

  • View - 这里放置表示类:单元格、辅助函数和模板文件。

7

templates

Template - 表示文件放置在此处:元素、错误页面、布局和视图模板文件。

8

tests

tests 文件夹是您放置应用程序测试用例的地方。

9

tmp

tmp 文件夹是 CakePHP 存储临时数据的地方。它实际存储的数据取决于您如何配置 CakePHP,但此文件夹通常用于存储模型描述以及有时存储会话信息。

10

vendor

vendor 文件夹是 CakePHP 和其他应用程序依赖项安装的地方。请承诺不要编辑此文件夹中的文件。如果您修改了核心,我们将无法为您提供帮助。

11

webroot

webroot 目录是应用程序的公共文档根目录。它包含您希望公开访问的所有文件。

命名规范

命名规范不是强制要求,但是一种良好的编码实践,并且在项目规模增大时非常有用。

控制器规范

控制器类名必须为复数,使用帕斯卡命名法,并且名称必须以 Controller 结尾。例如,对于 Students 类,控制器的名称可以是 StudentsController。控制器上的公共方法通常作为“操作”公开,可以通过 Web 浏览器访问。

例如,/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 中。

广告