$pageCountHeader public property The name of the HTTP header containing the information about total number of pages of data. This is used when serving a resource collection with pagination. public string $pageCountHeader = 'X-Pagination-Page-Count'

$metaEnvelope public property (available since version 2.0.4) The name of the envelope (e.g. _meta) for returning the pagination object. It takes effect only, if collectionEnvelope is set. public string $metaEnvelope = '_meta'

$linksEnvelope public property (available since version 2.0.4) The name of the envelope (e.g. _links) for returning the links objects. It takes effect only, if collectionEnvelope is set. public string $linksEnvelope = '_links'

$fieldsParam public property The name of the query parameter containing the information about which fields should be returned for a yii\base\Model object. If the parameter is not provided or empty, the default set of fields as defined by yii\base\Model::fields() will be returned. public string $fieldsParam = 'fields'

$expandParam public property The name of the query parameter containing the information about which fields should be returned in addition to those listed in $fieldsParam for a resource object. public string $expandParam = 'expand'

$currentPageHeader public property The name of the HTTP header containing the information about the current page number (1-based). This is used when serving a resource collection with pagination. public string $currentPageHeader = 'X-Pagination-Current-Page'

$collectionEnvelope public property The name of the envelope (e.g. items) for returning the resource objects in a collection. This is used when serving a resource collection. When this is set and pagination is enabled, the serializer will return a collection in the following format: [ 'items' => [...], // assuming collectionEnvelope is "items" '_links' => { // pagination links as returned by Pagination::getLinks() 'self' => '...', 'next' => '...',

run() public method Responds to the OPTIONS request. public void run ( $id = null )$id string

$resourceOptions public property The HTTP verbs that are supported by the resource URL public array $resourceOptions = ['GET', 'PUT', 'PATCH', 'DELETE', 'HEAD', 'OPTIONS']

$collectionOptions public property The HTTP verbs that are supported by the collection URL public array $collectionOptions = ['GET', 'POST', 'HEAD', 'OPTIONS']