PHP 클래스 Neomerx\JsonApi\Encoder\Encoder

상속: implements Neomerx\JsonApi\Contracts\Encoder\EncoderInterface
파일 보기 프로젝트 열기: neomerx/json-api 1 사용 예제들

보호된 프로퍼티들

프로퍼티 타입 설명
$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 )

withMeta() 공개 메소드

public withMeta ( $meta )

프로퍼티 상세

$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

$meta 보호되어 있는 프로퍼티

protected array|object|null $meta
리턴 array | object | null