Class yii\rest\Serializer

Serializer converts resource objects and collections into array representation.

Serializer is mainly used by REST controllers to convert different objects into array representation so that they can be further turned into different formats, such as JSON, XML, by response formatters.

The default implementation handles resources as yii\base\Model objects and collections as objects implementing yii\data\DataProviderInterface. You may override serialize() to handle more types.

Public Properties

Public Methods

Protected Methods

Property Details

$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' => '...',
        'last' => '...',
    },
    '_meta' => {  // meta information as returned by Pagination::toArray()
        'totalCount' => 100,
        'pageCount' => 5,
        'currentPage' => 1,
        'perPage' => 20,
    },
]

If this property is not set, the resource arrays will be directly returned without using envelope. The pagination information as shown in _links and _meta can be accessed from the response HTTP headers.

public string $collectionEnvelope = null

$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'

$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'

$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'

$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'

$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'

$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'

$perPageHeader public property

The name of the HTTP header containing the information about the number of data items in each page. This is used when serving a resource collection with pagination.

public string $perPageHeader = 'X-Pagination-Per-Page'

$preserveKeys public property (available since version 2.0.10)

Whether to preserve array keys when serializing collection data. Set this to true to allow serialization of a collection as a JSON object where array keys are used to index the model objects. The default is to serialize all collections as array, regardless of how the array is indexed.

See also serializeDataProvider().

public boolean $preserveKeys = false

$request public property

The current request. If not set, the request application component will be used.

public yii\web\Request $request = null

$response public property

The response to be sent. If not set, the response application component will be used.

public yii\web\Response $response = null

$totalCountHeader public property

The name of the HTTP header containing the information about total number of data items. This is used when serving a resource collection with pagination.

public string $totalCountHeader = 'X-Pagination-Total-Count'

Method Details