diff --git a/docs/guide-zh-CN/start-hello.md b/docs/guide-zh-CN/start-hello.md index e2e8151..f60d32f 100644 --- a/docs/guide-zh-CN/start-hello.md +++ b/docs/guide-zh-CN/start-hello.md @@ -1,7 +1,9 @@ 说声 Hello ============ -本章描述了如何在你的应用中创建一个新的 “Hello” 页面。为了实现这一目标,将会创建一个[操作](structure-controllers.md#creating-actions)和一个[视图](structure-views.md): +本章描述了如何在你的应用中创建一个新的 “Hello” 页面。为了实现这一目标, +将会创建一个[操作](structure-controllers.md#creating-actions) +和一个[视图](structure-views.md): * 应用将会分派页面请求给操作 * 操作将会依次渲染视图呈现 “Hello” 给最终用户 @@ -16,11 +18,17 @@ 创建操作 ------------------ -为了 “Hello”,需要创建一个 `say` [操作](structure-controllers.md#creating-actions),从请求中接收 `message` 参数并显示给最终用户。如果请求没有提供 `message` 参数,操作将显示默认参数 “Hello”。 +为了 “Hello”,需要创建一个 `say` [操作](structure-controllers.md#creating-actions), +从请求中接收 `message` 参数并显示给最终用户。 +如果请求没有提供 `message` 参数,操作将显示默认参数 “Hello”。 -> Info: [操作](structure-controllers.md#creating-actions)是最终用户可以直接访问并执行的对象。操作被组织在[控制器](structure-controllers.md)中。一个操作的执行结果就是最终用户收到的响应内容。 +> Info: [操作](structure-controllers.md#creating-actions)是最终用户可以直接访问并执行的对象。 + 操作被组织在[控制器](structure-controllers.md)中。 + 一个操作的执行结果就是最终用户收到的响应内容。 -操作必须声明在[控制器](structure-controllers.md)中。为了简单起见,你可以直接在 `SiteController` 控制器里声明 `say` 操作。这个控制器是由文件 `controllers/SiteController.php` 定义的。以下是一个操作的声明: +操作必须声明在[控制器](structure-controllers.md)中。为了简单起见, +你可以直接在 `SiteController` 控制器里声明 `say` 操作。 +这个控制器是由文件 `controllers/SiteController.php` 定义的。以下是一个操作的声明: ```php --------------- -[视图](structure-views.md)是你用来生成响应内容的脚本。为了说 “Hello”,你需要创建一个 `say` 视图,以便显示从操作方法中传来的 `message` 参数。 +[视图](structure-views.md)是你用来生成响应内容的脚本。为了说 “Hello”, +你需要创建一个 `say` 视图,以便显示从操作方法中传来的 `message` 参数。 ```php ``` -`say` 视图应该存为 `views/site/say.php` 文件。当一个操作中调用了 [[yii\web\Controller::render()|render()]] 方法时,它将会按 `views/控制器 ID/视图名.php` 路径加载 PHP 文件。 +`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)。 +注意以上代码,`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 脚本。视图脚本输出的内容将会作为响应结果返回给应用。应用将依次输出结果给最终用户。 +当然了,你大概会在 `say` 视图里放入更多内容。内容可以由 HTML 标签,纯文本, +甚至 PHP 语句组成。实际上 `say` 视图就是一个由 [[yii\web\Controller::render()|render()]] 执行的 PHP 脚本。 +视图脚本输出的内容将会作为响应结果返回给应用。应用将依次输出结果给最终用户。 试运行 @@ -81,19 +109,34 @@ http://hostname/index.php?r=site/say&message=Hello+World 这个 URL 将会输出包含 “Hello World” 的页面,页面和应用里的其它页面使用同样的头部和尾部。 -如果你省略 URL 中的 `message` 参数,将会看到页面只显示 “Hello”。这是因为 `message` 被作为一个参数传给 `actionSay()` 方法,当省略它时,参数将使用默认的 `“Hello”` 代替。 +如果你省略 URL 中的 `message` 参数,将会看到页面只显示 “Hello”。 +这是因为 `message` 被作为一个参数传给 `actionSay()` 方法,当省略它时,参数将使用默认的 `“Hello”` 代替。 -> Info: 新页面和其它页面使用同样的头部和尾部是因为 [[yii\web\Controller::render()|render()]] 方法会自动把 `say` 视图执行的结果嵌入称为[布局](structure-views.md#layouts)的文件中,本例中是 `views/layouts/main.php`。 +> Info: 新页面和其它页面使用同样的头部和尾部是因为 [[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()` 方法将被调用处理请求。 +上面 URL 中的参数 `r` 需要更多解释。 +它代表[路由](runtime-routing.md),是整个应用级的, +指向特定操作的独立 ID。路由格式是 `控制器 ID/操作 ID`。应用接受请求的时候会检查参数, +使用控制器 ID 去确定哪个控制器应该被用来处理请求。 +然后相应控制器将使用操作 ID 去确定哪个操作方法将被用来做具体工作。 +上述例子中,路由 `site/say` 将被解析至 `SiteController` 控制器和其中的 `say` 操作。 +因此 `SiteController::actionSay()` 方法将被调用处理请求。 -> Info: 与操作一样,一个应用中控制器同样有唯一的 ID。控制器 ID 和操作 ID 使用同样的命名规则。控制器的类名源自于控制器 ID,移除了连字符,每个单词首字母大写,并加上 `Controller` 后缀。例子:控制器 ID `post-comment` 相当于控制器类名 `PostCommentController`。 +> Info: 与操作一样,一个应用中控制器同样有唯一的 ID。 + 控制器 ID 和操作 ID 使用同样的命名规则。 + 控制器的类名源自于控制器 ID, + 移除了连字符,每个单词首字母大写,并加上 `Controller` 后缀。 + 例子:控制器 ID `post-comment` 相当于控制器类名 `PostCommentController`。 总结 ------- -通过本章节你接触了 MVC 设计模式中的控制器和视图部分。创建了一个操作作为控制器的一部分去处理特定请求。然后又创建了一个视图去构造响应内容。在这个小例子中,没有模型调用,唯一涉及到数据的地方是 `message` 参数。 +通过本章节你接触了 MVC 设计模式中的控制器和视图部分。 +创建了一个操作作为控制器的一部分去处理特定请求。 +然后又创建了一个视图去构造响应内容。在这个小例子中,没有模型调用,唯一涉及到数据的地方是 `message` 参数。 你同样学习了 Yii 路由的相关内容,它是用户请求与控制器操作之间的桥梁。