Класс yii\rest\Serializer

Serializer преобразует объекты ресурсов и коллекции в массив.

Serializer в основном используется контроллерами REST для преобразования различных объектов в представление массива, чтобы они могли быть дополнительно преобразованы в различные форматы, такие как JSON, XML, с помощью форматирователей ответов.

Стандартная реализация обрабатывает ресурсы как объекты yii\base\Model, а коллекции — как объекты, реализующие yii\data\DataProviderInterface. Вы можете переопределить serialize() для обработки других типов.

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

Публичные методы

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

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

$collectionEnvelope общедоступное свойство

Имя конверта (например, items) для возврата объектов ресурсов в коллекции. Используется при предоставлении коллекции ресурсов. Если это свойство установлено, и постраничное отображение включено, сериализатор вернет коллекцию в следующем формате:

[
    '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,
    },
]

Если это свойство не установлено, массивы ресурсов будут возвращены непосредственно без использования конверта. Информацию о постраничном отображении, как показано в _links и _meta, можно получить из заголовков ответа HTTP.

public string $collectionEnvelope = null

$currentPageHeader общедоступное свойство

Имя HTTP-заголовка, содержащего информацию о текущем номере страницы (1-основанная). Используется при предоставлении коллекции ресурсов с постраничным отображением.

public string $currentPageHeader = 'X-Pagination-Current-Page'

$expandParam общедоступное свойство

Имя параметра запроса, содержащего информацию о том, какие поля должны быть возвращены помимо тех, которые указаны в $fieldsParam для объекта ресурса.

public string $expandParam = 'expand'

$fieldsParam общедоступное свойство

Имя параметра запроса, содержащего информацию о том, какие поля должны быть возвращены для объекта yii\base\Model. Если параметр не указан или пуст, будет возвращен стандартный набор полей, определенный в yii\base\Model::fields().

public string $fieldsParam = 'fields'

$linksEnvelope общедоступное свойство (доступно с версии 2.0.4)

Имя конверта (например, _links) для возврата объектов ссылок. Действует только, если collectionEnvelope установлено.

public string $linksEnvelope = '_links'

$metaEnvelope общедоступное свойство (доступно с версии 2.0.4)

Имя конверта (например, _meta) для возврата объекта постраничного отображения. Действует только, если collectionEnvelope установлено.

public string $metaEnvelope = '_meta'

$pageCountHeader общедоступное свойство

Имя HTTP-заголовка, содержащего информацию о общем количестве страниц данных. Используется при предоставлении коллекции ресурсов с постраничным отображением.

public string $pageCountHeader = 'X-Pagination-Page-Count'

$perPageHeader общедоступное свойство

Имя HTTP-заголовка, содержащего информацию о количестве элементов данных на каждой странице. Используется при предоставлении коллекции ресурсов с постраничным отображением.

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

$preserveKeys общедоступное свойство (доступно с версии 2.0.10)

Сохранять ли ключи массива при сериализации данных коллекции. Установите это в true для сериализации коллекции как JSON-объекта, где ключи массива используются для индексации объектов модели. По умолчанию все коллекции сериализуются как массивы, независимо от того, как индексируется массив.

См. также serializeDataProvider().

public boolean $preserveKeys = false

$request общедоступное свойство

Текущий запрос. Если не задано, будет использован компонент приложения request.

public yii\web\Request $request = null

$response общедоступное свойство

Ответ, который нужно отправить. Если не задан, будет использован компонент приложения response.

public yii\web\Response $response = null

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

Имя HTTP-заголовка, содержащего информацию о полном количестве элементов данных. Используется при представлении ресурса коллекции с постраничной навигацией.

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

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