©
Dokumen ini menggunakan Manual laman web PHP Cina Lepaskan
控制器
控制器
在创建资源类和指定资源格输出式化后，下一步就是创建控制器操作将资源通过RESTful APIs展现给终端用户。
Yii 提供两个控制器基类来简化创建RESTful 操作的工作:yii\rest\Controller 和 yii\rest\ActiveController， 两个类的差别是后者提供一系列将资源处理成Active Record的操作。 因此如果使用Active Record内置的操作会比较方便，可考虑将控制器类 继承yii\rest\ActiveController，它会让你用最少的代码完成强大的RESTful APIs.
yii\rest\Controller 和 yii\rest\ActiveController 提供以下功能，一些功能在后续章节详细描述：
- HTTP 方法验证;
- 内容协商和数据格式化;
- 认证;
- 频率限制.
yii\rest\ActiveController 额外提供一下功能:
- 一系列常用操作:
index,view,create,update,delete,options; - 对操作和资源进行用户认证.
创建控制器类
当创建一个新的控制器类，控制器类的命名最好使用资源名称的单数格式，例如，提供用户信息的控制器 可命名为UserController.
创建新的操作和Web应用中创建操作类似，唯一的差别是Web应用中调用render()方法渲染一个视图作为返回值， 对于RESTful操作直接返回数据，yii\rest\Controller::serializer 和 yii\web\Response 会处理原始数据到请求格式的转换，例如
public function actionView($id){
return User::findOne($id);
}
过滤器
yii\rest\Controller提供的大多数RESTful API功能通过过滤器实现. 特别是以下过滤器会按顺序执行：
- yii\filters\ContentNegotiator: 支持内容协商，在 响应格式化 一节描述;
- yii\filters\VerbFilter: 支持HTTP 方法验证; the Authentication section;
- yii\filters\AuthMethod: 支持用户认证，在认证一节描述;
- yii\filters\RateLimiter: 支持频率限制，在频率限制 一节描述.
这些过滤器都在yii\rest\Controller::behaviors()方法中声明， 可覆盖该方法来配置单独的过滤器，禁用某个或增加你自定义的过滤器。 例如，如果你只想用HTTP 基础认证，可编写如下代码：
use yii\filters\auth\HttpBasicAuth;
public function behaviors(){
$behaviors = parent::behaviors();
$behaviors['authenticator'] = [
'class' => HttpBasicAuth::className(),
];
return $behaviors;
}
继承 ActiveController
如果你的控制器继承yii\rest\ActiveController，应设置yii\rest\ActiveController::modelClass 属性 为通过该控制器返回给用户的资源类名，该类必须继承yii\db\ActiveRecord.
自定义操作
yii\rest\ActiveController 默认提供一下操作:
- yii\rest\IndexAction: 按页列出资源;
- yii\rest\ViewAction: 返回指定资源的详情;
- yii\rest\CreateAction: 创建新的资源;
- yii\rest\UpdateAction: 更新一个存在的资源;
- yii\rest\DeleteAction: 删除指定的资源;
- yii\rest\OptionsAction: 返回支持的HTTP方法.
所有这些操作通过yii\rest\ActiveController::actions() 方法申明，可覆盖actions()方法配置或禁用这些操作， 如下所示：
public function actions(){
$actions = parent::actions();
// 禁用"delete" 和 "create" 操作
unset($actions['delete'], $actions['create']);
// 使用"prepareDataProvider()"方法自定义数据provider
$actions['index']['prepareDataProvider'] = [$this, 'prepareDataProvider'];
return $actions;
}
public function prepareDataProvider(){
// 为"index"操作准备和返回数据provider
}
请参考独立操作类的参考文档学习哪些配置项有用。
执行访问检查
通过RESTful APIs显示数据时，经常需要检查当前用户是否有权限访问和操作所请求的资源， 在yii\rest\ActiveController中，可覆盖yii\rest\ActiveController::checkAccess()方法来完成权限检查。
public function checkAccess($action, $model = null, $params = []){
// 检查用户能否访问 $action 和 $model
// 访问被拒绝应抛出ForbiddenHttpException
}
checkAccess() 方法默认会被yii\rest\ActiveController默认操作所调用，如果创建新的操作并想执行权限检查， 应在新的操作中明确调用该方法。
checkAccess()。