CodeIgniter 的正确命名结构

2024-02-16

我正在开始我的第一个 CodeIgniter 项目,并希望在开始之前获得一些建议。我对控制器和模型的名称如何工作有点困惑。

如果我希望我的公司页面的网址为http://example.com/Company/view http://example.com/Company/view

控制器需要被称为Company.php,正确吗? 在公司控制器内部,它看起来像这样:

public function viewAll()
{
    $this->load->model('Companymodel');
    $this->load->view('templates/header');
    $data['result'] = $this->Companymodel->viewAll();
    $this->load->view('company/viewAll', $data);
    $this->load->view('templates/footer');
}

好吧,我在这里很困惑,在上面的第 4 行:

$this->load->model('Companymodel');

对公司模型页面的调用需要第一个字母大写,其余字母小写吗?

如果这是正确的,模型文件是否需要称为 Companymodel.php 并放置在 application/models 文件夹中?

将控制器和模型称为相同的做法是不好的做法吗

示例:Company.php 并将其放置在 /application/controller/ 中 然后将模型命名为 Company.php 并将其放置在应用程序/模型中,或者模型应该命名为 Companymodel.php

我想我的最终问题是控制器和模型文件的命名约定,以及它们是否可以大写。


URLs

您的 URL 通常应全部为小写字母。如果您期望使用大写字母,则您有可能会意外排除它们的小写字母,即使它们是相同的 URL。例子:www.example.com/controller/method/param

控制器

控制器类名除首字母外应全部小写。

  • 如果您的网址是www.example.com/gallery,控制器名称为Gallery.
  • 如果您的网址是www.example.com/admin_folder,控制器名称为Admin_folder.

控制器文件名应与类名匹配,但全部小写。

  • 画廊::gallery.php
  • 管理文件夹::admin_folder.php

控制器方法也应该全部小写。大写字母有一定的灵活性,但与 URL 类似,有可能会出现问题(这是一个例子 https://stackoverflow.com/questions/16738179/codeigniter-2-callback-function-in-my-controller其中大写字母会干扰表单验证回调方法)。

Models

模型遵循与控制器相同的大部分约定。唯一的区别是模型方法名称,它可以使用您偏好的大小写。由于这些方法不依赖于 URL,并且使用普通的 PHP OOP 进行调用,因此您可以随意命名它们。

建议使用全小写版本加载模型。虽然 CI 不要求这样做,但如果某些用户使用大写字母加载它,然后尝试以全小写形式访问它,则可能会让某些用户感到困惑(这是由于本机 PHP 对类属性 [和一般变量] 区分大小写) ,而不是 CodeIgniter)。

  • 模型类名:Users_model (the _model后缀也不是必需的,但有些人可能会将其用作个人喜好,或者防止与Users控制器)。
  • 模型文件名:users_model.php
  • 模型加载:$this->load->model('users_model')
  • 模型方法名称(都可以):$this->users->getAll(), $this->users->find_by_name($name), etc.

图书馆

图书馆遵循相同的约定except为文件名。在他们的例子中,文件名应该与类名匹配。

与模型类似,建议使用小写名称加载库。

这些规则对于 CI 的库是相同的(位于application/core and application/libraries以及自定义或第三方库。

特别提示:扩展默认 CI 库时,前缀定义在application/config.php发挥作用。此前缀通常应全部大写,后跟下划线。默认为MY_.

  • 库类名:Photos
  • 库文件名:Photos.php,
  • 库负载:$this->load->library('photos')

Helpers

助手名称和加载全部小写。文件名由助手名称和_helper后附。

  • 帮手姓名:url
  • 帮助文件名称:url_helper.php
  • 辅助负载:$this->load->helper('url')

Notes

CodeIgniter 的命名约定有些不一致,但确实没有太多规则,因此很容易习惯和记忆。我很少遇到 CI 中的命名和加载问题,当我遇到问题时,通常是因为我正在从事与 Composer 相关的项目,所以我养成了不同的习惯。

本答案中的规则适用于撰写本文时的 CodeIgniter 2.1.x。 Github 上有关于 3.0 的讨论更好并增加命名约定的一致性 https://github.com/EllisLab/CodeIgniter/issues/1805,如果您愿意,您可以阅读并做出贡献。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

CodeIgniter 的正确命名结构 的相关文章

随机推荐