Class yii\rest\IndexAction

继承yii\rest\IndexAction » yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
实现yii\base\Configurable
可用自版本2.0
源代码 https://github.com/yiisoft/yii2/blob/master/framework/rest/IndexAction.php

IndexAction 实现用于列出多个模型的 API 端点.

有关 IndexAction 的更多详细信息和用法信息, 请参阅 guide article on rest controllers.

公共属性

隐藏继承的属性

属性类型描述定义在
$behaviors yii\base\Behavior[] 附加到此组件的行为列表. 该属性是只读的. yii\base\Component
$checkAccess callable 一个 PHP 可调用对象, 在允许动作以确定当前用户是否有权执行该动作时将被调用. yii\rest\Action
$controller yii\base\Controller|yii\web\Controller|yii\console\Controller 拥有此动作的控制器. yii\base\Action
$dataFilter yii\data\DataFilter|null 用于搜索过滤器组成的数据过滤器. yii\rest\IndexAction
$findModel callable 一个 PHP 可调用对象, 将被调用以返回与指定的主键值相对应的模型. yii\rest\Action
$id string 动作 ID. yii\base\Action
$modelClass string 此动作将处理的模型的类名称. yii\rest\Action
$prepareDataProvider callable 一个可调用对象, 将被调用以准备一个数据提供者, 该数据提供者应返回模型的集合. yii\rest\IndexAction
$uniqueId string 整个应用程序中此动作的唯一 ID. 该属性是只读的. yii\base\Action

公共方法

隐藏继承的方法

方法描述定义在
__call() 调用不是类方法的已命名方法. yii\base\BaseObject
__clone() 在通过克隆现有对象创建对象之后调用此方法. yii\base\Component
__construct() 构造函数. yii\base\Action
__get() 返回对象属性的值. yii\base\BaseObject
__isset() 检查属性是否已设置, 即已定义且不为null. yii\base\BaseObject
__set() 设置对象属性的值. yii\base\BaseObject
__unset() 将对象属性设置为null. yii\base\BaseObject
attachBehavior() 将行为附加到此组件. yii\base\Component
attachBehaviors() 将行为列表附加到组件. yii\base\Component
behaviors() 返回此组件应该具有的行为列表. yii\base\Component
canGetProperty() 返回一个值, 指示属性是否可读. yii\base\BaseObject
canSetProperty() 返回一个值, 指示属性是否可写. yii\base\BaseObject
className() 返回此类的完全限定名称. yii\base\BaseObject
detachBehavior() 从组件中分离一个行为. yii\base\Component
detachBehaviors() 分离组件中的所有行为. yii\base\Component
ensureBehaviors() 确保在 behaviors() 中声明的行为已附加到此组件. yii\base\Component
findModel() 根据给定的主键返回数据模型. yii\rest\Action
getBehavior() 返回指定的行为对象. yii\base\Component
getBehaviors() 返回附加到此组件的所有行为. yii\base\Component
getUniqueId() 返回整个应用程序中此动作的唯一 ID. yii\base\Action
hasEventHandlers() 返回一个值, 指示是否有任何处理程序附加到指定的事件. yii\base\Component
hasMethod() 返回一个值, 指示方法是否已定义. yii\base\BaseObject
hasProperty() 返回一个值, 指示属性是否已定义. yii\base\BaseObject
init() 初始化对象. yii\rest\Action
off() 从该组件分离现有的事件处理程序. yii\base\Component
on() 将事件处理程序附加到事件. yii\base\Component
run() yii\rest\IndexAction
runWithParams() 使用指定的参数运行此动作. yii\base\Action
trigger() 触发事件. yii\base\Component

受保护的方法

隐藏继承的方法

方法描述定义在
afterRun() 在执行run()之后立即调用此方法. yii\base\Action
beforeRun() 在执行run()之前立即调用此方法. yii\base\Action
prepareDataProvider() 准备应返回所请求的模型集合的数据提供者. yii\rest\IndexAction

属性详情

$dataFilter public 属性 (可用自版本: 2.0.13)

用于搜索过滤器组成的数据过滤器.

你必须显示的设置此字段才能启用过滤器处理.

例如:

[
    'class' => 'yii\data\ActiveDataFilter',
    'searchModel' => function () {
        return (new \yii\base\DynamicModel(['id' => null, 'name' => null, 'price' => null]))
            ->addRule('id', 'integer')
            ->addRule('name', 'trim')
            ->addRule('name', 'string')
            ->addRule('price', 'number');
    },
]

参见 yii\data\DataFilter.

$prepareDataProvider public 属性

一个可调用对象, 将被调用以准备一个数据提供者, 该数据提供者应返回模型的集合. 如果未设置, 则将使用 prepareDataProvider(). 可调用对象的签名应为:

function (IndexAction $action) {
    // $action 是当前正在运行的动作对象.
}

可调用对象应返回 yii\data\ActiveDataProvider 的实例.

如果设置了 $dataFilter, 则 yii\data\DataFilter::build() 的结果将作为第二个参数传递给可调用对象. 在这种情况下, 可调用对象的签名应为:

function (IndexAction $action, mixed $filter) {
    // $action 是当前正在运行的动作对象.
    // $filter 内置的过滤条件.
}

方法详情

prepareDataProvider() protected 方法

准备应返回所请求的模型集合的数据提供者.

protected yii\data\ActiveDataProvider prepareDataProvider ( )
run() public 方法

public yii\data\ActiveDataProvider run ( )