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

getLinks() 추상적인 공개 메소드

The method returns a new Links schema object if you want to provide linkage data for the document or null if the section should be omitted from the response.

abstract public getLinks ( ) : WoohooLabs\Yin\JsonApi\Schema\Links \| null
리턴	WoohooLabs\Yin\JsonApi\Schema\Links \| 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