PHP Класс Neomerx\JsonApi\Encoder\Encoder

Наследование: implements Neomerx\JsonApi\Contracts\Encoder\EncoderInterface

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$container	Neomerx\JsonApi\Contracts\Schema\ContainerInterface
$encoderOptions	Neomerx\JsonApi\Encoder\EncoderOptions \| null
$factory	Neomerx\JsonApi\Contracts\Factories\FactoryInterface
$isAddJsonApiVersion	boolean
$jsonApiVersionMeta	mixed \| null
$links	array \| null	Links in array format.
$meta	array \| object \| null

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

Метод	Описание
__construct ( Neomerx\JsonApi\Contracts\Factories\FactoryInterface $factory, Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container, Neomerx\JsonApi\Encoder\EncoderOptions $encoderOptions = null )
encodeData ( $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null )
encodeError ( Neomerx\JsonApi\Contracts\Document\ErrorInterface $error )
encodeErrors ( $errors )
encodeIdentifiers ( $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null )
encodeMeta ( $meta )
instance ( array $schemas = [], Neomerx\JsonApi\Encoder\EncoderOptions $encodeOptions = null ) : Neomerx\JsonApi\Contracts\Encoder\EncoderInterface	Create encoder instance.
withJsonApiVersion ( $meta = null )
withLinks ( array $links )
withMeta ( $meta )
withRelationshipRelatedLink ( $resource, $relationshipName, $meta = null, $treatAsHref = false )
withRelationshipSelfLink ( $resource, $relationshipName, $meta = null, $treatAsHref = false )

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

Метод	Описание
checkInputData ( mixed $data )
encodeDataInternal ( Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container, object \| array \| Iterato\Iterator \| null $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null ) : string
encodeToJson ( array $document ) : string	Encode array to JSON.
getFactory ( ) : Neomerx\JsonApi\Contracts\Factories\FactoryInterface

Приватные методы

Метод	Описание
configureUrlPrefix ( Neomerx\JsonApi\Contracts\Document\DocumentInterface $docWriter )
createParametersAnalyzer ( Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null ) : Neomerx\JsonApi\Contracts\Encoder\Parameters\ParametersAnalyzerInterface
resetEncodeParameters ( )	Reset encode parameters.

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

__construct() публичный Метод

public __construct ( Neomerx\JsonApi\Contracts\Factories\FactoryInterface $factory, Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container, Neomerx\JsonApi\Encoder\EncoderOptions $encoderOptions = null )
$factory	Neomerx\JsonApi\Contracts\Factories\FactoryInterface
$container	Neomerx\JsonApi\Contracts\Schema\ContainerInterface
$encoderOptions	Neomerx\JsonApi\Encoder\EncoderOptions

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

protected checkInputData ( mixed $data )
$data	mixed

encodeData() публичный Метод

public encodeData ( $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null )
$parameters	Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

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

protected encodeDataInternal ( Neomerx\JsonApi\Contracts\Schema\ContainerInterface $container, object \| array \| Iterato\Iterator \| null $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null ) : string
$container	Neomerx\JsonApi\Contracts\Schema\ContainerInterface
$data	object \| array \| Iterato\Iterator \| null
$parameters	Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface
Результат	string

encodeError() публичный Метод

public encodeError ( Neomerx\JsonApi\Contracts\Document\ErrorInterface $error )
$error	Neomerx\JsonApi\Contracts\Document\ErrorInterface

encodeErrors() публичный Метод

public encodeErrors ( $errors )

encodeIdentifiers() публичный Метод

public encodeIdentifiers ( $data, Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface $parameters = null )
$parameters	Neomerx\JsonApi\Contracts\Encoder\Parameters\EncodingParametersInterface

encodeMeta() публичный Метод

public encodeMeta ( $meta )

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

Encode array to JSON.

protected encodeToJson ( array $document ) : string
$document	array
Результат	string

getFactory() защищенный статический Метод

protected static getFactory ( ) : Neomerx\JsonApi\Contracts\Factories\FactoryInterface
Результат	Neomerx\JsonApi\Contracts\Factories\FactoryInterface

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

Create encoder instance.

public static instance ( array $schemas = [], Neomerx\JsonApi\Encoder\EncoderOptions $encodeOptions = null ) : Neomerx\JsonApi\Contracts\Encoder\EncoderInterface
$schemas	array	Schema providers.
$encodeOptions	Neomerx\JsonApi\Encoder\EncoderOptions
Результат	Neomerx\JsonApi\Contracts\Encoder\EncoderInterface

withJsonApiVersion() публичный Метод

public withJsonApiVersion ( $meta = null )

withLinks() публичный Метод

public withLinks ( array $links )
$links	array

withMeta() публичный Метод

public withMeta ( $meta )

withRelationshipRelatedLink() публичный Метод

public withRelationshipRelatedLink ( $resource, $relationshipName, $meta = null, $treatAsHref = false )

withRelationshipSelfLink() публичный Метод

public withRelationshipSelfLink ( $resource, $relationshipName, $meta = null, $treatAsHref = false )

Описание свойств

$container защищенное свойство

protected ContainerInterface,Neomerx\JsonApi\Contracts\Schema $container
Результат	Neomerx\JsonApi\Contracts\Schema\ContainerInterface

$encoderOptions защищенное свойство

protected EncoderOptions,Neomerx\JsonApi\Encoder\|null $encoderOptions
Результат	Neomerx\JsonApi\Encoder\EncoderOptions \| null

$factory защищенное свойство

protected FactoryInterface,Neomerx\JsonApi\Contracts\Factories $factory
Результат	Neomerx\JsonApi\Contracts\Factories\FactoryInterface

$isAddJsonApiVersion защищенное свойство

protected bool $isAddJsonApiVersion
Результат	boolean

$jsonApiVersionMeta защищенное свойство

protected mixed\|null $jsonApiVersionMeta
Результат	mixed \| null

$links защищенное свойство

Links in array format.

protected array\|null $links
Результат	array \| null

$meta защищенное свойство

protected array\|object\|null $meta
Результат	array \| object \| null