Класс yii\rest\OptionsAction

Все классы | Свойства | Методы

Наследование	yii\rest\OptionsAction » yii\base\Action » yii\base\Component » yii\base\Object
Реализует	yii\base\Configurable
Доступна с версии	2.0
Исходный код	https://github.com/yiisoft/yii2/blob/master/framework/rest/OptionsAction.php

OptionsAction отвечает на запрос OPTIONS, отправив обратно заголовок Allow.

Дополнительную информацию и сведения об использовании OptionsAction см. в статье руководства по контроллерам REST.

Публичные свойства

Свойство	Тип	Описание	Определено
$behaviors	yii\base\Behavior[]	Список присоединённых к этому компоненту поведений	yii\base\Component
$collectionOptions	array	HTTP-методы, поддерживаемые URL-адресом коллекции	yii\rest\OptionsAction
$controller	yii\base\Controller\|yii\web\Controller	Контроллер, которому принадлежит данное действие	yii\base\Action
$id	string	Идентификатор действия	yii\base\Action
$resourceOptions	array	HTTP-методы, поддерживаемые URL-адресом ресурса	yii\rest\OptionsAction
$uniqueId	string	Уникальный идентификатор этого действия во всём приложении.	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
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\base\Object
off()	Отсоединяет существующий обработчик событий от этого компонента.	yii\base\Component
on()	Присоединяет обработчик событий к событию.	yii\base\Component
run()	Откликается на запрос OPTIONS.	yii\rest\OptionsAction

runWithParams()	Выполняет этот action с указанными параметрами.	yii\base\Action
trigger()	Вызывает событие.	yii\base\Component

Защищённые методы

Метод	Описание	Определено в
afterRun()	Этот метод вызывается сразу после выполнения `run()`.	yii\base\Action
beforeRun()	Этот метод вызывается прямо перед выполнением `run()`.	yii\base\Action

Подробное описание свойств

$collectionOptions общественное свойство

HTTP-глаголы, поддерживаемые URL-адресом коллекции

public array $collectionOptions = ['GET', 'POST', 'HEAD', 'OPTIONS']

$resourceOptions общественное свойство

HTTP-глаголы, поддерживаемые URL-адресом ресурса

public array $resourceOptions = ['GET', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']

Подробное описание методов

run() общественный метод

Отвечает на запрос OPTIONS.

public void run ( $id = null )
$id	string

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc-2.0/yii-rest-optionsaction.html