mirror of
https://github.com/yiisoft/yii2.git
synced 2025-08-26 14:26:54 +08:00
new chinese translation
This commit is contained in:
@ -1,58 +1,31 @@
|
||||
Controllers
|
||||
控制器
|
||||
===========
|
||||
|
||||
After creating the resource classes and specifying how resource data should be formatted, the next thing
|
||||
to do is to create controller actions to expose the resources to end users through RESTful APIs.
|
||||
在创建资源类和指定资源格输出式化后,下一步就是创建控制器操作将资源通过RESTful APIs展现给终端用户。
|
||||
|
||||
Yii provides two base controller classes to simplify your work of creating RESTful actions:
|
||||
[[yii\rest\Controller]] and [[yii\rest\ActiveController]]. The difference between these two controllers
|
||||
is that the latter provides a default set of actions that are specifically designed to deal with
|
||||
resources represented as [Active Record](db-active-record.md). So if you are using [Active Record](db-active-record.md)
|
||||
and are comfortable with the provided built-in actions, you may consider extending your controller classes
|
||||
from [[yii\rest\ActiveController]], which will allow you to create powerful RESTful APIs with minimal code.
|
||||
Yii 提供两个控制器基类来简化创建RESTful 操作的工作:[[yii\rest\Controller]] 和 [[yii\rest\ActiveController]],
|
||||
两个类的差别是后者提供一系列将资源处理成[Active Record](db-active-record.md)的操作。
|
||||
因此如果使用[Active Record](db-active-record.md)内置的操作会比较方便,可考虑将控制器类
|
||||
继承[[yii\rest\ActiveController]],它会让你用最少的代码完成强大的RESTful APIs.
|
||||
|
||||
Both [[yii\rest\Controller]] and [[yii\rest\ActiveController]] provide the following features, some of which
|
||||
will be described in detail in the next few sections:
|
||||
[[yii\rest\Controller]] 和 [[yii\rest\ActiveController]] 提供以下功能,一些功能在后续章节详细描述:
|
||||
|
||||
* HTTP method validation;
|
||||
* [Content negotiation and Data formatting](rest-response-formatting.md);
|
||||
* [Authentication](rest-authentication.md);
|
||||
* [Rate limiting](rest-rate-limiting.md).
|
||||
* HTTP 方法验证;
|
||||
* [内容协商和数据格式化](rest-response-formatting.md);
|
||||
* [认证](rest-authentication.md);
|
||||
* [频率限制](rest-rate-limiting.md).
|
||||
|
||||
[[yii\rest\ActiveController]] in addition provides the following features:
|
||||
[[yii\rest\ActiveController]] 额外提供一下功能:
|
||||
|
||||
* A set of commonly needed actions: `index`, `view`, `create`, `update`, `delete`, `options`;
|
||||
* User authorization in regarding to the requested action and resource.
|
||||
* 一系列常用操作: `index`, `view`, `create`, `update`, `delete`, `options`;
|
||||
* 对操作和资源进行用户认证.
|
||||
|
||||
|
||||
## Creating Controller Classes <a name="creating-controller"></a>
|
||||
## 创建控制器类 <a name="creating-controller"></a>
|
||||
|
||||
When creating a new controller class, a convention in naming the controller class is to use
|
||||
the type name of the resource and use singular form. For example, to serve user information,
|
||||
the controller may be named as `UserController`.
|
||||
当创建一个新的控制器类,控制器类的命名最好使用资源名称的单数格式,例如,提供用户信息的控制器
|
||||
可命名为`UserController`.
|
||||
|
||||
Creating a new action is similar to creating an action for a Web application. The only difference
|
||||
is that instead of rendering the result using a view by calling the `render()` method, for RESTful actions
|
||||
you directly return the data. The [[yii\rest\Controller::serializer|serializer]] and the
|
||||
[[yii\web\Response|response object]] will handle the conversion from the original data to the requested
|
||||
format. For example,
|
||||
创建新的操作和Web应用中创建操作类似,唯一的差别是Web应用中调用`render()`方法渲染一个视图作为返回值,
|
||||
对于RESTful操作直接返回数据,[[yii\rest\Controller::serializer|serializer]] 和
|
||||
[[yii\web\Response|response object]] 会处理原始数据到请求格式的转换,例如
|
||||
@ -65,29 +38,17 @@ public function actionView($id)
|
||||
```
|
||||
|
||||
|
||||
## Filters <a name="filters"></a>
|
||||
## 过滤器 <a name="filters"></a>
|
||||
|
||||
Most RESTful API features provided by [[yii\rest\Controller]] are implemented in terms of [filters](structure-filters.md).
|
||||
In particular, the following filters will be executed in the order they are listed:
|
||||
[[yii\rest\Controller]]提供的大多数RESTful API功能通过[过滤器](structure-filters.md)实现.
|
||||
特别是以下过滤器会按顺序执行:
|
||||
|
||||
* [[yii\filters\ContentNegotiator|contentNegotiator]]: supports content negotiation, to be explained in
|
||||
the [Response Formatting](rest-response-formatting.md) section;
|
||||
* [[yii\filters\ContentNegotiator|contentNegotiator]]: 支持内容协商,在 [响应格式化](rest-response-formatting.md) 一节描述;
|
||||
* [[yii\filters\VerbFilter|verbFilter]]: supports HTTP method validation;
|
||||
* [[yii\filters\VerbFilter|verbFilter]]: 支持HTTP 方法验证;
|
||||
* [[yii\filters\AuthMethod|authenticator]]: supports user authentication, to be explained in
|
||||
the [Authentication](rest-authentication.md) section;
|
||||
* [[yii\filters\AuthMethod|authenticator]]: 支持用户认证,在[认证](rest-authentication.md)一节描述;
|
||||
* [[yii\filters\RateLimiter|rateLimiter]]: 支持频率限制,在[频率限制](rest-rate-limiting.md) 一节描述.
|
||||
* [[yii\filters\RateLimiter|rateLimiter]]: supports rate limiting, to be explained in
|
||||
the [Rate Limiting](rest-rate-limiting.md) section.
|
||||
|
||||
These named filters are declared in the [[yii\rest\Controller::behaviors()|behaviors()]] method.
|
||||
You may override this method to configure individual filters, disable some of them, or add your own filters.
|
||||
For example, if you only want to use HTTP basic authentication, you may write the following code:
|
||||
这些过滤器都在[[yii\rest\Controller::behaviors()|behaviors()]]方法中声明,
|
||||
可覆盖该方法来配置单独的过滤器,禁用某个或增加你自定义的过滤器。
|
||||
例如,如果你只想用HTTP 基础认证,可编写如下代码:
|
||||
@ -106,28 +67,16 @@ public function behaviors()
|
||||
```
|
||||
|
||||
|
||||
## Extending `ActiveController` <a name="extending-active-controller"></a>
|
||||
## 继承 `ActiveController` <a name="extending-active-controller"></a>
|
||||
|
||||
If your controller class extends from [[yii\rest\ActiveController]], you should set
|
||||
its [[yii\rest\ActiveController::modelClass||modelClass]] property to be the name of the resource class
|
||||
that you plan to serve through this controller. The class must extend from [[yii\db\ActiveRecord]].
|
||||
如果你的控制器继承[[yii\rest\ActiveController]],应设置[[yii\rest\ActiveController::modelClass||modelClass]] 属性
|
||||
为通过该控制器返回给用户的资源类名,该类必须继承[[yii\db\ActiveRecord]].
|
||||
|
||||
|
||||
### Customizing Actions <a name="customizing-actions"></a>
|
||||
### 自定义操作 <a name="customizing-actions"></a>
|
||||
|
||||
By default, [[yii\rest\ActiveController]] provides the following actions:
|
||||
[[yii\rest\ActiveController]] 默认提供一下操作:
|
||||
|
||||
* [[yii\rest\IndexAction|index]]: list resources page by page;
|
||||
* [[yii\rest\ViewAction|view]]: return the details of a specified resource;
|
||||
* [[yii\rest\CreateAction|create]]: create a new resource;
|
||||
* [[yii\rest\UpdateAction|update]]: update an existing resource;
|
||||
* [[yii\rest\DeleteAction|delete]]: delete the specified resource;
|
||||
* [[yii\rest\OptionsAction|options]]: return the supported HTTP methods.
|
||||
* [[yii\rest\IndexAction|index]]: 按页列出资源;
|
||||
* [[yii\rest\ViewAction|view]]: 返回指定资源的详情;
|
||||
* [[yii\rest\CreateAction|create]]: 创建新的资源;
|
||||
@ -135,8 +84,6 @@ By default, [[yii\rest\ActiveController]] provides the following actions:
|
||||
* [[yii\rest\DeleteAction|delete]]: 删除指定的资源;
|
||||
* [[yii\rest\OptionsAction|options]]: 返回支持的HTTP方法.
|
||||
|
||||
All these actions are declared through the [[yii\rest\ActiveController::actions()|actions()]] method.
|
||||
You may configure these actions or disable some of them by overriding the `actions()` method, like shown the following,
|
||||
所有这些操作通过[[yii\rest\ActiveController::actions()|actions()]] 方法申明,可覆盖`actions()`方法配置或禁用这些操作,
|
||||
如下所示:
|
||||
|
||||
@ -160,16 +107,11 @@ public function prepareDataProvider()
|
||||
}
|
||||
```
|
||||
|
||||
Please refer to the class references for individual action classes to learn what configuration options are available.
|
||||
请参考独立操作类的参考文档学习哪些配置项有用。
|
||||
|
||||
|
||||
### Performing Access Check <a name="performing-access-check"></a>
|
||||
### 执行访问检查 <a name="performing-access-check"></a>
|
||||
|
||||
When exposing resources through RESTful APIs, you often need to check if the current user has the permission
|
||||
to access and manipulate the requested resource(s). With [[yii\rest\ActiveController]], this can be done
|
||||
by overriding the [[yii\rest\ActiveController::checkAccess()|checkAccess()]] method like the following,
|
||||
通过RESTful APIs显示数据时,经常需要检查当前用户是否有权限访问和操作所请求的资源,
|
||||
在[[yii\rest\ActiveController]]中,可覆盖[[yii\rest\ActiveController::checkAccess()|checkAccess()]]方法来完成权限检查。
|
||||
|
||||
@ -195,10 +137,7 @@ public function checkAccess($action, $model = null, $params = [])
|
||||
}
|
||||
```
|
||||
|
||||
The `checkAccess()` method will be called by the default actions of [[yii\rest\ActiveController]]. If you create
|
||||
new actions and also want to perform access check, you should call this method explicitly in the new actions.
|
||||
`checkAccess()` 方法默认会被[[yii\rest\ActiveController]]默认操作所调用,如果创建新的操作并想执行权限检查,
|
||||
应在新的操作中明确调用该方法。
|
||||
|
||||
> Tip: You may implement `checkAccess()` by using the [Role-Based Access Control (RBAC) component](security-authorization.md).
|
||||
> 提示: 可使用[Role-Based Access Control (RBAC) 基于角色权限控制组件](security-authorization.md)实现`checkAccess()`。
|
||||
|
Reference in New Issue
Block a user