CakePHP - 文件夹结构

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

文件夹结构

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

CakePHP 的结构

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

Sr.No 文件夹名称和说明
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 −包含应用程序的表、实体和行为。

  • 视图展示类放在此处:单元格、帮助程序和模板文件。

7

templates

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

8

tests

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

9

tmp

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

10

vendor

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

11

webroot

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

命名约定

命名约定不是必须遵循的,但它是一种很好的编码实践,随着项目的发展,它将非常有用。

控制器约定

控制器类名必须是复数,采用 PascalCased 格式,并且名称必须以 Controller 结尾。例如,对于 Students 类,控制器的名称可以是 StudentsController。控制器上的公共方法通常作为可通过 Web 浏览器访问的"操作"公开。

例如,/users /view 开箱即用地映射到 UsersController 的 view() 方法。受保护或私有的方法无法通过路由访问。

文件和类名约定

大多数情况下,我们已经看到我们的类名文件名几乎相同。这在 cakephp 中是类似的。

例如,StudentsController 类将具有名为 StudentsController.php 的文件。这些文件必须保存为模块名称,并保存在 app 文件夹中的相应文件夹中。

数据库约定

用于 CakePHP 模型的表,大多具有带下划线的复数名称。

例如,student_details、student_marks。如果字段名称由两个单词组成,例如 first_name、last_name,则字段名称带有下划线。

模型约定

对于模型,类按照数据库表命名,名称为复数,采用 PascalCased 格式,后缀为 Table。

例如,StudentDetailsTable、StudentMarksTable

视图约定

对于视图模板,文件基于控制器函数。

例如,如果类 StudentDetailsController 具有函数 showAll(),则视图模板将命名为 show_all.php 并保存在 template/yrmodule/show_all.php 中。