yiiapi/docs/guide/zh_cn/basics.convention.txt

这里只显示每个文件的开头 60 行。登录后可以解锁完整代码。

微信扫码关注公众号，代码整理好后第一时间通知你。

开发规范
===========

Yii 偏爱规范胜于配置。遵循规范可使你能够创建成熟的Yii应用而不需要编写、维护复杂的配置。
当然了，在必要时，Yii 仍然可以在几乎所有的方面通过配置实现自定义。

下面我们讲解 Yii 编程中推荐的开发规范。
为简单起见，我们假设 `WebRoot` 是 Yii 应用安装的目录。

URL
---

默认情况下，Yii 识别如下格式的 URL：

~~~
http://hostname/index.php?r=ControllerID/ActionID
~~~

`r` GET 变量意为
[路由（route）](/doc/guide/basics.controller#route) ，它可以被Yii解析为 控制器和动作。
如果 `ActionID` 被省略，控制器将使用默认的动作（在[CController::defaultAction]中定义）；
如果 `ControllerID` 也被省略（或者 `r` 变量不存在），应用将使用默认的控制器
（在[CWebApplication::defaultController]中定义）。

通过 [CUrlManager] 的帮助，可以创建更加可识别，更加 SEO 友好的 URL，例如
`http://hostname/ControllerID/ActionID.html`。此功能在 [URL Management](/doc/guide/topics.url) 中有详细讲解。


代码
----

Yii 推荐命名变量、函数和类时使用 驼峰风格，即每个单词的首字母大写并连在一起，中间无空格。
变量名和函数名应该使它们的第一个单词全部小写，以使其区别于类名（例如：`$basePath`,
`runController()`, `LinkPager`）。对私有类成员变量来说，我们推荐以下划线作为其名字前缀（例如： `$_actionList`）。

由于在 PHP 5.3.0 之前不支持名字空间，我们推荐类要通过某种独立的方式命名，以避免和第三方类发生冲突。鉴于此，
所有的 Yii 框架类名以 "C" 作前缀。

一个针对控制器名字的特殊规则是它们必须以单词 `Controller` 结尾。那么控制器 ID 即类名的首字母小写并去掉单词 `Controller`。
例如，`PageController` 类的 ID 就是  `page` 。这个规则使应用更加安全。它还使控制器相关的URL更加简单(例如 `/index.php?r=page/index` 而不是 
`/index.php?r=PageController/index`)。

配置
-------------

配置是一个键值对数组。每个键代表了所配置的对象中的属性名，每个值则为相应属性的初始值。
例如， `array('name'=>'My
application', 'basePath'=>'./protected')` 初始化了 `name` 和
`basePath` 属性为它们相应的数组值。

类中任何可写的属性都可以被配置。如果没有配置，属性将使用它们的默认值。
当配置一个属性时，最好阅读相应文档以保证初始值正确。

文件
----

命名和使用文件的规范取决于它们的类型。

类文件应以它们包含的公有类命名。例如， [CController] 类位于 `CController.php` 文件中。
公有类是可以被任何其他类使用的类。每个类文件应包含最多一个公有类。