Класс yii\rest\IndexAction
| Наследование | yii\rest\IndexAction » yii\rest\Action » yii\base\Action » yii\base\Component » yii\base\Object |
|---|---|
| Реализует | yii\base\Configurable |
| Доступна с версии | 2.0 |
| Исходный код | https://github.com/yiisoft/yii2/blob/master/framework/rest/IndexAction.php |
IndexAction реализует конечную точку API для перечисления нескольких моделей.
Для получения дополнительной информации и инструкций по использованию IndexAction, обратитесь к статье руководства по контроллерам rest.
Публичные свойства
| Свойство | Тип | Описание | Определено |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | Список прикрепленных к этому компоненту поведений | yii\base\Component |
| $checkAccess | callable | Функция PHP, которая будет вызываться при выполнении действия для определения, имеет ли текущий пользователь разрешение на выполнение действия. | yii\rest\Action |
| $controller | yii\base\Controller|yii\web\Controller | Контроллер, владеющий этим действием | yii\base\Action |
| $findModel | callable | Функция PHP, которая будет вызываться для возвращения модели, соответствующей указанному значению первичного ключа. | yii\rest\Action |
| $id | string | ID действия | yii\base\Action |
| $modelClass | string | Имя класса модели, которая будет обрабатываться этим действием. | yii\rest\Action |
| $prepareDataProvider | callable | Функция PHP, которая будет вызываться для подготовки поставщика данных, который должен вернуть коллекцию моделей. | yii\rest\IndexAction |
| $uniqueId | string | Уникальный ID этого действия во всём приложении. | yii\base\Action |
Публичные методы
| Метод | Описание | Определено |
|---|---|---|
| __call() | Вызывает метод с указанным именем, который не является методом класса. | yii\base\Object |
| __clone() | Этот метод вызывается после создания объекта путем клонирования существующего. | yii\base\Component |
| __construct() | Конструктор. | yii\base\Object |
| __get() | Возвращает значение свойства объекта. | yii\base\Object |
| __isset() | Проверяет, установлено ли свойство, т.е. определено и не равно null. | yii\base\Object |
| __set() | Устанавливает значение свойства объекта. | yii\base\Object |
| __unset() | Устанавливает свойство объекта в значение null. | yii\base\Object |
| attachBehavior() | Прикрепляет поведение к этому компоненту. | yii\base\Component |
| attachBehaviors() | Прикрепляет список поведений к компоненту. | yii\base\Component |
| behaviors() | Возвращает список поведений, которые должен иметь этот компонент. | yii\base\Component |
| canGetProperty() | Возвращает значение, указывающее, можно ли прочитать свойство. | yii\base\Object |
| canSetProperty() | Возвращает значение, указывающее, можно ли установить свойство. | yii\base\Object |
| className() | Возвращает полное квалифицированное имя этого класса. | yii\base\Object |
| 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() | Возвращает уникальный идентификатор этого действия во всём приложении. | yii\base\Action |
| hasEventHandlers() | Возвращает значение, указывающее, есть ли обработчик, прикрепленный к указанному событию. | yii\base\Component |
| hasMethod() | Возвращает значение, указывающее, определён ли метод. | yii\base\Object |
| hasProperty() | Возвращает значение, указывающее, определено ли свойство. | yii\base\Object |
| 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 |
Подробности о свойствах
$prepareDataProvider публичное свойство
Функция PHP, которая будет вызываться для подготовки поставщика данных, который должен вернуть коллекцию моделей. Если не установлено, будет использоваться prepareDataProvider() вместо этого. Подпись вызываемой функции должна быть:
function ($action) {
// $action is the action object currently running
}
Вызываемый объект должен возвращать экземпляр yii\data\ActiveDataProvider.
public callable $prepareDataProvider = null
Подробное описание методов
prepareDataProvider() защищённый метод
Подготавливает поставщик данных, который должен возвращать запрашиваемый набор моделей.
| защищённый yii\data\ActiveDataProvider prepareDataProvider ( ) |
|---|
run() публичный метод
| публичный yii\data\ActiveDataProvider run ( ) |
|---|
© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-rest-indexaction.html
