Skip to content

Y
yii2
Commit c640ea85 by riverlet
Options

Merge branch 'master' of https://github.com/yii2-chinesization/yii2

parents 3fd3de0a 3ef7fe70
Showing with 232 additions and 58 deletions
docs/guide-zh-CN/concept-components.md 0 → 100644
组件（Component）
==========
组件是 Yii 应用的主要基石之一。组件是 [[yii\base\Component]] 类或其子类的实例。三个它能提供，其他类不能的主要功能有：
* [属性（Property）](concept-properties.md)
* [事件（Event）](concept-events.md)
* [行为（Behavior）](concept-behaviors.md)
或单独使用，或彼此配合，总之这些功能的应用让 Yii 的类变得更加灵活和易用。就拿一个叫 [[yii\jui\DatePicker|日期选择器]]
的小部件来举例吧，这是个方便你在 [视图](structure-view.md) 中生成一个交互式日期选择器的 UI 组件，你们自己看这样的调用方式是不是很屌：
```php
use yii\jui\DatePicker;
echo DatePicker::widget([
'language' => 'zh-CN',
'name' => 'country',
'clientOptions' => [
'dateFormat' => 'yy-mm-dd',
],
]);
```
正因为这个小部件继承自 [[yii\base\Component]]，所以它的各项属性改写起来就会很容易……
虽然组件非常屌爆，但是他们比常规的对象（Object）要稍微重量级一点点，因为他们要使用额外的内存和 CPU 时间来支持这些功能，尤其是
[事件](concept-events.md) 和 [行为](concept-behaviors.md) 这俩货。如果你的组件不需要这两项功能，你可以考虑继承 [[yii\base\Object]]
而不是 [[yii\base\Component]]。这样一来，你的组件就可以像普通 PHP 对象一样高效了。同时，它还依旧支持[属性（Property）](concept-properties.md)功能！
当你继承 [[yii\base\Component]] 或 [[yii\base\Object]] 时，我们推荐你使用如下的编码风格：
- 若你需要重写构造器（Constructor），指定一个 `$config` 参数，作为构造器的 *最后一个* 参数，然后把它传递给父类的构造器。（译者注：`parent::__construct($config = [])`，用于把属性配置信息传递回父类。可选参数放最后是 PSR 的规范之一）
- 永远在你重写的构造器 *结尾处* 调用一下父类的构造器。
- 如果你重写了 [[yii\base\Object::init()]] 方法，请确保你在 `init` 方法的 *开头处* 调用了父类的 `init` 方法。
例子如下：
```php
namespace yii\components\MyClass;
use yii\base\Object;
class MyClass extends Object
{
public $prop1;
public $prop2;
public function __construct($param1, $param2, $config = [])
{
// ... 配置生效前的初始化过程
parent::__construct($config);
}
public function init()
{
parent::init();
// ... 配置生效后的初始化过程
}
}
```
另外，为了让你的组件可以在创建实例时[能被正确配置](concept-configurations.md)，请遵照以下操作流程。举例：
```php
$component = new MyClass(1, 2, ['prop1' => 3, 'prop2' => 4]);
// 方法二：
$component = \Yii::createObject([
'class' => MyClass::className(),
'prop1' => 3,
'prop2' => 4,
], [1, 2]);
```
> 补充：虽然调用 [[Yii::createObject()]] 的方法看起来更加复杂，但是这主要是因为它更加灵活强大，这货是基于高大上的[依赖注入容器](concept-di-container.md)的一种实现。
每个 [[yii\base\Object]] 类的生命周期是这样度过的：
1. 构造器内的预初始化过程。你可以在这儿给各属性设置缺省值。
2. 通过 `$config` 配置对象。配置的过程可能会覆盖掉先前在构造器内设置的默认值。
3. 在 [[yii\base\Object::init()|init()]] 方法内进行初始化的收尾工作。你可以通过重写此方法，进行一些良品检验呀，属性的标准化呀，之类的事情。
4. 对象方法调用。
前三步都是在对象的构造器内发生的。这意味着一旦你获得了一个对象实例，那么它已经初始化为了一个妥妥的状态，放心大胆的用吧。
docs/guide-zh-CN/start-hello.md 0 → 100644
说声 Hello
============
本小节描述如何在你的应用中创建一个新的 “Hello” 页面。为了做到这点，你将会创建一个[操作](structure-controllers.md#creating-actions)和一个[视图](structure-views.md)：
* 应用将会分派页面请求给操作
* 操作将会依次渲染视图呈现 “Hello” 给最终用户
贯穿整个小节，你将会掌握三件事：
1. 如何创建一个[操作](structure-controllers.md)去响应请求，
2. 如何创建一个[视图](structure-views.md)去构造响应内容，
3. 以及一个应用如何分派请求给[操作](structure-controllers.md#creating-actions)。
创建操作 <a name="creating-action"></a>
------------------
为了说 “Hello”，你需要创建一个 `say` [操作](structure-controllers.md#creating-actions)，从请求中接收 `message` 参数并显示给最终用户。如果请求没有提供 `message` 参数，操作将显示默认参数 “Hello”。
> 补充：[操作](structure-controllers.md#creating-actions)是最终用户可以直接访问并执行的对象。操作被组织在[控制器](structure-controllers.md)中。一个操作的执行结果就是最终用户将会收到的响应内容。
操作必须声明在[控制器](structure-controllers.md)中。为了简单起见，你可以直接在 `SiteController` 控制器里声明 `say` 操作。这个控制器是由文件 `controllers/SiteController.php` 定义的。以下是一个操作的声明：
```php
<?php
namespace app\controllers;
use yii\web\Controller;
class SiteController extends Controller
{
// ...其它代码...
public function actionSay($message = '你好')
{
return $this->render('say', ['message' => $message]);
}
}
```
在上述 `SiteController` 代码中，`say` 操作被定义为 `actionSay` 方法。Yii 使用 `action` 前缀区分普通方法和操作。`action` 前缀后面的名称被映射为操作的 ID。
涉及到给操作命名时，你应该理解 Yii 如何处理操作 ID。操作 ID 总是被以小写处理，如果一个操作 ID 由多个单词组成，单词之间将由连字符连接（如 `create-comment`）。操作 ID 映射为方法名时移除了连字符，将每个单词首字母大写，并加上 `action` 前缀。 例子：操作 ID `create-comment` 相当于方法名 `actionCreateComment`。
上述代码中的操作方法接受一个参数 `$message`，它的默认值是 `“Hello”`（就像你设置其它 PHP 函数或方法的默认值一样）。当应用接收到请求并确定由 `say` 操作来响应请求时，应用将从请求的参数中寻找对应值传入进来。换句话说，如果请求包含一个 `message` 参数，它的值是 `“Goodybye”`， 操作方法中的 `$message` 变量也将被填充为 `“Goodbye”`。
在操作方法中，[[yii\web\Controller::render()|render()]] 被用来渲染一个名为 `say` 的[视图](structure-views.md)文件。 `message` 参数也被传入视图，这样就可以在里面使用。操作方法会返回渲染结果。结果会被应用接收并显示给最终用户的浏览器（作为整页 HTML 的一部分）。
创建视图 <a name="creating-view"></a>
---------------
[视图](structure-views.md)是你用来生成响应内容的脚本。为了说 “Hello”，你需要创建一个 `say` 视图，以便显示从操作方法中传来的 `message` 参数。
```php
<?php
use yii\helpers\Html;
?>
<?= Html::encode($message) ?>
```
`say` 视图应该存为 `views/site/say.php` 文件。当一个操作中调用了 [[yii\web\Controller::render()|render()]] 方法时，它将会按 `views/控制器 ID/视图名.php` 路径加载 PHP 文件。
注意以上代码，`message` 参数在输出之前被 [[yii\helpers\Html::encode()|HTML-encoded]] 方法处理过。这非常有必要，当参数来自于最终用户时，参数中的恶意 JavaScript 代码会导致[跨站脚本（XSS）攻击](http://en.wikipedia.org/wiki/Cross-site_scripting)。
当然了，你大概会在 `say` 视图里放入更多内容。内容可以由 HTML 标签，纯文本，甚至 PHP 语句组成。实际上 `say` 视图就是一个由 [[yii\web\Controller::render()|render()]] 执行的 PHP 脚本。视图脚本输出的内容将会作为响应结果返回给应用。应用将依次输出结果给最终用户。
尝试下 <a name="trying-it-out"></a>
-------------
创建完操作和视图后，你就可以通过下面的 URL 访问新页面了：
```
http://hostname/index.php?r=site/say&message=Hello+World
```
![Hello World](images/start-hello-world.png)
这个 URL 将会输出包含 “Hello World” 的页面，页面和应用里的其它页面使用同样的头部和尾部。
如果你省略 URL 中的 `message` 参数，将会看到页面只显示 “Hello”。这是因为 `message` 被作为一个参数传给 `actionSay()` 方法，当省略它时，参数将使用默认的 `“Hello”` 代替。
> 补充：新页面和其它页面使用同样的头部和尾部是因为 [[yii\web\Controller::render()|render()]] 方法会自动把 `say` 视图执行的结果嵌入称为[布局](structure-views.md#layouts)的文件中，本例中是 `views/layouts/main.php`。
上面 URL 中的参数 `r` 需要更多解释。它代表[路由](runtime-routing.md)，整个应用级的，指向特定操作的独立 ID。路由格式是 `控制器 ID/操作 ID`。应用接受请求的时候会检查参数，使用控制器 ID 去确定哪个控制器应该被用来处理请求。然后相应控制器将使用操作 ID 去确定哪个操作方法将被用来做具体工作。上述例子中，路由 `site/say` 将被解析至 `SiteController` 控制器和其中的 `say` 操作。因此 `SiteController::actionSay()` 方法将被调用处理请求。
> 补充：与操作一样，一个应用中控制器同样有唯一的 ID。控制器 ID 和操作 ID 使用同样的命名规则。控制器的类名源自于控制器 ID，移除了连字符，每个单词首字母大写，并加上 `Controller` 后缀。例子：控制器 ID `post-comment` 相当于控制器类名 `PostCommentController`。
总结 <a name="summary"></a>
-------
在本小节你已经接触了 MVC 设计模式中的控制器和视图部分。你创建了一个操作作为控制器的一部分去处理特定请求。然后你又创建了一个视图去构造响应内容。在这个小例子中，没有模型调用，唯一涉及到数据的地方是 `message` 参数。
你同样学习了 Yii 路由的相关内容，它是用户请求与控制器操作之间的桥梁。
在下一节，你将学习如何创建一个模型，以及添加一个包含 HTML 表单的页面。
docs/guide-zh-CN/start-workflow.md
运行应用程序
运行应用
====================
Yii 安装后，就有了一个可以运行的 Yii 应用程序，你可以通过 URL `http://hostname/basic/web/index.php` 或
`http://hostname/index.php` 访问它，具体要取决于你的配置。本章将介绍此应用程序的内置功能，代码的组织方式以及总体上程序是怎样处理请求
的。
> Info: 为简单起见，这个“入门”教程假设你已经将 `basic/web` 设置为了 Web 服务器的文档根目录。访问此程序的是类似
`http://hostname/index.php` 的 URL 。请根据你的实际情况，在下文描述中作相应调整。
安装 Yii 后，你就有了一个运行中的 Yii 应用，根据不同配置，可以通过 `http://hostname/basic/web/index.php` 或 `http://hostname/index.php` 访问。本小节将介绍应用的内建功能，如何组织代码，以及一般情况下应用如何处理请求。
> 补充：为简单起见，在整个“入门”章节中都假定你已经把 `basic/web` 设为 Web 服务器根目录并配置完毕，你访问应用的地址会是 `http://lostname/index.php` 或类似的。请按需调整 URL。
功能 <a name="functionality"></a>
-------------
安装的基础应用程序包含四个页面：
一个安装完的基本应用包含四页：
* 首页，访问 URL `http://hostname/index.php` 时显示，
* "About" 页面，
* "Contact" 页面，显示一个联络表单，允许终端用户通过电子邮件与你联系。
* 还有 "Login" 页面，显示一个登录表单，用于验证终端用户。请尝试使用“admin/admin”登录，你将发现主菜单上原来的“Login”变成了“Logout”。
* 主页，当你访问 `http://hostname/index.php` 时显示,
* “About” 页面，
* “Contact” 页， 显示一个联系表单，允许终端用户通过 Email 联系你，
* “Login” 页， 显示一个登录表单，用来验证终端用户。试着使用 “admin/admin” 登录，你可以看到当前是登录状态，已经可以“退出登录”了。
这些页面共享一个通用的 header 和 footer。Header 含有一个主菜单，可以导航到不同的页面。
这些页面使用同一个头部和尾部。头部包含了一个可以在不同页面间切换的导航栏。
你应该还会在浏览器窗口的最下面发现有一个工具条。这是一个 Yii 提供的很有用的[调试工具](tool-debugger.md)，它会记录并显示很多调试信息，
例如日志消息，响应状态，数据库执行的查询等等。
在浏览器底部可以看到一个工具栏。
这是个 Yii 提供的很有用的[调试工具](tool-debugger.md)，可以记录并显示大量的调试信息，例如日志信息，响应状态，数据库查询等等。
应用程序结构 <a name="application-structure"></a>
应用结构 <a name="application-structure"></a>
---------------------
在你的应用程序中最重要的目录和文件是（假设程序的根目录是`basic`）：
应用中最重要的目录和文件（假设应用根目录是 `basic`）：
```
basic/ 应用程序根目录
composer.json 用于 Composer，描述包的信息
config/ 包含应用程序及其他配置信息。
console.php 控制台应用程序配置
web.php Web 应用程序配置
basic/ 应用根目录
composer.json Composer 配置文件, 描述包信息
config/ 包含应用配置及其它配置
console.php 控制台应用配置信息
web.php Web 应用配置信息
commands/ 包含控制台命令类
controllers/ 包含控制器类
models/ 包含模型类
runtime/ 包含 Yii 运行时产生的文件，例如日志和缓存文件等
vendor/ 包含已安装的 Componser 包，包括 Yii 框架本身。
runtime/ 包含 Yii 在运行时生成的文件，例如日志和缓存文件
vendor/ 包含已经安装的 Composer 包，包括 Yii 框架自身
views/ 包含视图文件
web/ 应用程序 Web 根目录，包含可通过 Web 访问的文件
assets/ 包含 Yii 已发布的资源文件（javascript 和 css）
index.php 应用程序的入口（或引导）脚本
yii Yii 控制台命令可执行脚本
web/ Web 应用根目录，包含 Web 入口文件
assets/ 包含 Yii 发布的资源文件（javascript 和 css）
index.php 应用入口文件
yii Yii 控制台命令执行脚本
```
总体上，应用程序中的文件可以分为两类：位于 `basic/web` 中的和那些位于其他目录中的。前者可通过 HTTP （例如，在一个浏览器中）直接访问，
后者则不能且不应该能。
Yii 实现了 [模型-视图-控制器 (MVC)](http://wikipedia.org/wiki/Model-view-controller) 设计模式，在上述目录组织中也有体现。
`models` 目录中包含了所有的[模型类](structure-models.md)，`views` 目录包含了所有的[视图脚本](structure-views.md)，
`controllers` 目录包含了所有[控制器类](structure-controllers.md)。
一般来说，应用中的文件可被分为两类：在 `basic/web` 下的和在其它目录下的。前者可以直接通过 HTTP 访问（例如浏览器），后者不能也不应该被直接访问。
Yii 实现了[模型-视图-控制器 (MVC)](http://wikipedia.org/wiki/Model-view-controller)设计模式，这点在上述目录结构中也得以体现。 `models` 目录包含了所有[模型类](structure-models.md)，`views` 目录包含了所有[视图脚本](structure-views.md)，`controllers` 目录包含了所有[控制器类](structure-controllers.md)。
下图展示了一个应用程序的静态结构。
以下图表展示了一个应用的静态结构：
![应用程序的静态结构](images/application-structure.png)
![应用静态结构](images/application-structure.png)
每个应用程序都有一个入口脚本 `web/index.php`，它是应用程序中仅有的可通过 Web 访问的 PHP 脚本。这个入口脚本接收一个传入请求并创建一个
[应用程序](structure-applications.md) 实例处理该请求。[应用程序](structure-applications.md)在其[组件](concept-components.md)
的帮助下解析请求并将请求分派到 MVC 元素上。[视图](structure-views.md)中使用[挂件](structure-widgets.md)协助构建复杂动态的用户接口
元素。
每个应用都有一个入口脚本 `web/index.php`，这应该是整个应用中唯一可以访问的 PHP 脚本。入口脚本接受一个 Web 请求并创建[应用](structure-application.md)实例去处理它。 [应用](structure-applications.md)在它的[组建](concept-components.md)的辅助下解析请求，并分派请求至 MVC 元素。[视图](structure-views.md)使用[小部件](structure-widgets.md)去创建复杂和动态的用户界面。
请求的生命周期 <a name="request-lifecycle"></a>
请求生命周期 <a name="request-lifecycle"></a>
-----------------
下图展示了一个应用是如何处理请求的。
![请求的生命周期](images/application-lifecycle.png)
1. 一个用户提交了对[入口脚本（entry script）](structure-entry-scripts.md) `web/index.php` 的请求。
2. 入口脚本加载应用程序[配置信息（configuration）](concept-configurations.md)并创建一个[应用程序](structure-applications.md)实
例处理该请求。
3. 应用程序在[请求（request）]应用程序组件的协助下解析所请求的[路由（route）](runtime-routing.md)。
4. 应用程序创建一个[控制器（controller）](structure-controllers.md)实例处理该请求。
5. 控制器创建了一个[动作（action）](structure-controllers.md)实例，执行动作中的过滤器（filter）。
6. 如果有任何一个过滤器处理失败，则动作取消。
7. 如果所有的过滤器都执行通过，则动作执行。
8. 动作载入一个数据模型，可能是从一个数据库中加载。
9. 动作渲染一个视图（view），给它提供数据模型。
10. 渲染结果返回给[响应（response）](runtime-responses.md)应用程序组件。
11. 响应组件发送渲染结果到用户的浏览器。
以下图表展示了一个应用如何处理请求：
![请求生命周期](images/application-lifecycle.png)
1. 用户向 [入口脚本](structure-entry-scripts.md) `web/index.php` 发起请求。
2. 入口脚本加载应用 [配置](concept-configurations.md)并创建一个[应用](structure-applications.md)实例去处理请求。
3. 应用通过[请求](runtime-request.md)组件解析请求的[路由](runtime-routing.md)。
4. 应用创建一个[控制器](structure-controllers.md)实例去处理请求。
5. 控制器创建一个[操作](structure-controllers.md)实例并针对操作执行过滤器。
6. 如果任何一个过滤器返回失败，则操作退出。
7. 如果所有过滤器都通过，操作将被执行。
8. 操作会加载一个数据模型，或许是来自数据库。
9. 操作会渲染一个视图，把数据模型提供给它。
10. 渲染结果返回给[响应](runtime-responses.md)组件。
11. 响应组件发送渲染结果给用户浏览器。
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment