OptionsAction

API reference › yii › rest › OptionsAction

class	`yii\rest\OptionsAction`
Extends	`yii\base\Action` » `yii\base\Component` » `yii\base\BaseObject`
Implements	`yii\base\Configurable`
Since	2.0
Source	`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.

Properties

Property	Type	Description	Defined by
`$behaviors` read-only	`array<yii\base\Behavior<static>>`	List of behaviors attached to this component.	`yii\base\Component`
`$collectionOptions`	`array`	The HTTP verbs that are supported by the collection URL Default: `['GET', 'POST', 'HEAD', 'OPTIONS']`.	`OptionsAction`
`$controller`	`yii\base\T\|null`	The controller that owns this action, or `null` when the action runs standalone. via `Module::$actionMap` Default: `null`.	`yii\base\Action`
`$id`	`string\|null`	ID of the action; `null` between construction and dispatcher post-assignment for standalone actions resolved through `Module::$actionMap` or `Module::$actionNamespace`. Default: `null`.	`yii\base\Action`
`$module`	`yii\base\Module\|null`	The owning module, or `null` if neither a module nor a controller is attached. Available since 22.0.	`yii\base\Action`
`$resourceOptions`	`array`	The HTTP verbs that are supported by the resource URL Default: `['GET', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']`.	`OptionsAction`
`$uniqueId` read-only	`string`	The unique ID of this action among the whole application.	`yii\base\Action`

Methods

Method	Description	Defined by
`__construct()`	Constructor.	`yii\base\Action`
`__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`
`__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()` static	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`
`getModule()`	Returns the module that owns this action when invoked standalone.	`yii\base\Action`
`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.	`OptionsAction`
`runWithParams()`	Runs this action with the specified parameters.	`yii\base\Action`
`setModule()`	Sets the module that owns this action when invoked standalone.	`yii\base\Action`
`trigger()`	Triggers an event.	`yii\base\Component`
`afterRun()` protected	This method is called right after `run()` is executed.	`yii\base\Action`
`beforeRun()` protected	This method is called right before `run()` is executed.	`yii\base\Action`
`resolveStandaloneParams()` protected	Resolves typed parameters of `run()` when the action is invoked without a hosting controller.	`yii\base\Action`

Method details

run()

public function run(string|null $id = null): mixed

Responds to the OPTIONS request.

Parameters

Parameter	Type	Description
`$id`	`string\|null`

Returns

mixed