Yii覆盖通用休息函数

时间:2014-12-14 21:02:47

标签: php rest yii2

我是yii2的新手。我想在yii框架中写一些restful api。从3天的搜索,我能够运行宁静的服务示例。我发现yii自动生成这些方法的索引,查看,创建,更新,删除。如果我想自定义索引,创建,更新和删除方法,我该怎么办?因为我只找到了自定义indexData函数输出的方法,即prepareDataProvider。如果我添加新方法,我该怎么办?或者,如果yii不提供创建,更新和删除方法的自定义,那么编写自己的自定义方法会更好。

2 个答案:

答案 0 :(得分:7)

您可以通过在actions()课程中定义ActiveController方法来覆盖原始行为。

以下是一个例子:

 public function actions()
 {
     return array_merge(parent::actions(), [
         'create' => null, // Disable create
         'view' => [
             'class' => 'yii\rest\ViewAction',
             'modelClass' => $this->modelClass,
             'checkAccess' => [$this, 'checkAccess'],
             'findModel' => ['\path\to\your\callback', 'findModelByYourOwnMethod'],
         ],
         'update' => [
             'class' => 'path\to\your\UpdateAction',
             'modelClass' => $this->modelClass,
             'checkAccess' => [$this, 'checkAccess'],
             'scenario' => SCENARIO_UPDATE,
         ],
     ]);
 }

您可以定义自己的动作类,场景等。如果要覆盖部分动作但不是所有动作,请记住与parent::actions()合并。

修改

通常,您可以通过以下方式在控制器中添加额外的操作:1)声明方法actionX(),其中X是操作的名称;和/或2)声明方法actions(),它返回动作配置数组,就像上面的例子一样。 Yii2框架提供了一个特殊的控制器\yii\rest\ActiveController,它为CRUD和索引提供了实现的操作。

如果您阅读了源代码,您会注意到在ActiveController中,有actions()方法定义了与上述示例类似的内容。每个操作都链接到同一个包下的class,例如'index' => ['class' => 'yii\rest\IndexAction']。每个操作中的实现都是不同的,其中一些提供了一个可选的可调用变量,供开发人员设置和覆盖原始行为。例如,IndexAction为您提供$prepareDataProvider;覆盖;您可以在我的示例中看到,$findModel是另一个出现在每个 rest 操作中的内容。

除非社区有强烈需求,否则我不会在此处列出此类可调用变量的列表。要了解为了扩展休息操作行为需要填写的内容,请检查框架的rest文件夹下的源代码:https://github.com/yiisoft/yii2/tree/master/framework/rest;还有,我还有另一个答案可以帮助您了解更多:Yii2 Restful API - Example to Add a New Action

答案 1 :(得分:0)

我知道这很老了,但是我觉得这个问题与我回答的问题非常相似。值得在这里查看我的答案:https://stackoverflow.com/a/50744982/3337682

希望它对某人有帮助。

〜干杯:)