# Class yii\rest\OptionsAction

Inheritance | yii\rest\OptionsAction » yii\base\Action » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2/blob/master/framework/rest/OptionsAction.php

OptionsAction responds to the OPTIONS request by sending back an `Allow` header.

For more details and usage information on OptionsAction, see the guide article on rest controllers.

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component
$collectionOptions | array | The HTTP verbs that are supported by the collection URL | yii\rest\OptionsAction
$controller | yii\base\Controller|yii\web\Controller|yii\console\Controller | The controller that owns this action | yii\base\Action
$id | string | ID of the action | yii\base\Action
$resourceOptions | array | The HTTP verbs that are supported by the resource URL | yii\rest\OptionsAction
$uniqueId | string | The unique ID of this action among the whole application. This property is read-only. | yii\base\Action

## Public Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
__call() | Calls the named method which is not a class method. | yii\base\Component
__clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component
__construct() | Constructor. | yii\base\Action
__get() | Returns the value of a component property. | yii\base\Component
__isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component
__set() | Sets the value of a component property. | yii\base\Component
__unset() | Sets a component property to be null. | yii\base\Component
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component
canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component
className() | Returns the fully qualified name of this class. | yii\base\BaseObject
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getUniqueId() | Returns the unique ID of this action among the whole application. | yii\base\Action
hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component
hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component
hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component
init() | Initializes the object. | yii\base\BaseObject
off() | Detaches an existing event handler from this component. | yii\base\Component
on() | Attaches an event handler to an event. | yii\base\Component
run() | Responds to the OPTIONS request. | yii\rest\OptionsAction
runWithParams() | Runs this action with the specified parameters. | yii\base\Action
trigger() | Triggers an event. | yii\base\Component

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
afterRun() | This method is called right after `run()` is executed. | yii\base\Action
beforeRun() | This method is called right before `run()` is executed. | yii\base\Action

## Property Details

$collectionOptions public property

The HTTP verbs that are supported by the collection URL

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

The HTTP verbs that are supported by the resource URL

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

## Method Details

run() public method

Responds to the OPTIONS request.

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