PHP Класс WoohooLabs\Yin\JsonApi\Document\AbstractDocument

Показать файл Открыть проект

Открытые методы

Метод Описание
getJsonApi ( ) : WoohooLabs\Yin\JsonApi\Schema\JsonApi | null Provides information about the "jsonApi" section of the current document.
getLinks ( ) : WoohooLabs\Yin\JsonApi\Schema\Links | null Provides information about the "links" section of the current document.
getMeta ( ) : array Provides information about the "meta" section of the current document.

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

Метод Описание
transformBaseContent ( array $additionalMeta = [] ) : array
transformJsonApiContent ( array &$content )
transformLinksContent ( array &$content )
transformMetaContent ( array &$content, array $additionalMeta = [] )

Описание методов

getJsonApi() абстрактный публичный Метод

The method returns a new JsonApi schema object if this section should be present or null if it should be omitted from the response.
abstract public getJsonApi ( ) : WoohooLabs\Yin\JsonApi\Schema\JsonApi | null
Результат WoohooLabs\Yin\JsonApi\Schema\JsonApi | null

getMeta() абстрактный публичный Метод

The method returns an array of non-standard meta information about the document. If this array is empty, the section won't appear in the response.
abstract public getMeta ( ) : array
Результат array

transformBaseContent() защищенный Метод

protected transformBaseContent ( array $additionalMeta = [] ) : array
$additionalMeta array
Результат array

transformJsonApiContent() защищенный Метод

protected transformJsonApiContent ( array &$content )
$content array

transformLinksContent() защищенный Метод

protected transformLinksContent ( array &$content )
$content array

transformMetaContent() защищенный Метод

protected transformMetaContent ( array &$content, array $additionalMeta = [] )
$content array
$additionalMeta array