PHP 클래스 Neomerx\JsonApi\Schema\SchemaProvider

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

보호된 프로퍼티들

프로퍼티 타입 설명
$isShowAttributesInIncluded boolean
$resourceType string
$selfSubUrl Must start with '/' e.g. '/sub-url'

공개 메소드들

메소드 설명
__construct ( Neomerx\JsonApi\Contracts\Schema\SchemaFactoryInterface $factory )
createResourceObject ( $resource, $isOriginallyArrayed, $attributeKeysFilter = null )
getIncludePaths ( )
getIncludedResourceLinks ( $resource )
getInclusionMeta ( $resource )
getLinkageMeta ( $resource )
getPrimaryMeta ( $resource )
getRelationshipObjectIterator ( $resource, $isPrimary, array $includeRelationships )
getRelationshipRelatedLink ( $resource, $name, $meta = null, $treatAsHref = false )
getRelationshipSelfLink ( $resource, $name, $meta = null, $treatAsHref = false )
getRelationships ( object $resource, boolean $isPrimary, array $includeRelationships ) : array Get resource links.
getRelationshipsInclusionMeta ( $resource )
getRelationshipsPrimaryMeta ( $resource )
getResourceLinks ( $resource )
getResourceType ( )
getSelfSubLink ( $resource )
getSelfSubUrl ( $resource = null )
isShowAttributesInIncluded ( )

보호된 메소드들

메소드 설명
createLink ( string $subHref, null | mixed $meta = null, boolean $treatAsHref = false ) : Neomerx\JsonApi\Contracts\Document\LinkInterface
createRelationshipObject ( object $resource, string $name, array $desc ) : Neomerx\JsonApi\Contracts\Schema\RelationshipObjectInterface
getRelationshipRelatedUrl ( object $resource, string $name ) : string
getRelationshipSelfUrl ( object $resource, string $name ) : string
readLinks ( object $resource, string $relationshipName, array $description, boolean $isShowSelf, boolean $isShowRelated ) : array

비공개 메소드들

메소드 설명
getValue ( array $array, string $key, mixed $default = null ) : mixed

메소드 상세

__construct() 공개 메소드

public __construct ( Neomerx\JsonApi\Contracts\Schema\SchemaFactoryInterface $factory )
$factory Neomerx\JsonApi\Contracts\Schema\SchemaFactoryInterface

createRelationshipObject() 보호된 메소드

protected createRelationshipObject ( object $resource, string $name, array $desc ) : Neomerx\JsonApi\Contracts\Schema\RelationshipObjectInterface
$resource object
$name string
$desc array
리턴 Neomerx\JsonApi\Contracts\Schema\RelationshipObjectInterface

createResourceObject() 공개 메소드

public createResourceObject ( $resource, $isOriginallyArrayed, $attributeKeysFilter = null )

getIncludePaths() 공개 메소드

public getIncludePaths ( )

getInclusionMeta() 공개 메소드

public getInclusionMeta ( $resource )

getLinkageMeta() 공개 메소드

public getLinkageMeta ( $resource )

getPrimaryMeta() 공개 메소드

public getPrimaryMeta ( $resource )

getRelationshipObjectIterator() 공개 메소드

public getRelationshipObjectIterator ( $resource, $isPrimary, array $includeRelationships )
$includeRelationships array

getRelationshipRelatedUrl() 보호된 메소드

protected getRelationshipRelatedUrl ( object $resource, string $name ) : string
$resource object
$name string
리턴 string

getRelationshipSelfUrl() 보호된 메소드

protected getRelationshipSelfUrl ( object $resource, string $name ) : string
$resource object
$name string
리턴 string

getRelationships() 공개 메소드

Get resource links.
public getRelationships ( object $resource, boolean $isPrimary, array $includeRelationships ) : array
$resource object
$isPrimary boolean
$includeRelationships array A list of relationships that will be included as full resources.
리턴 array

getRelationshipsInclusionMeta() 공개 메소드

public getRelationshipsInclusionMeta ( $resource )

getRelationshipsPrimaryMeta() 공개 메소드

public getRelationshipsPrimaryMeta ( $resource )

getResourceType() 공개 메소드

public getResourceType ( )

getSelfSubUrl() 공개 메소드

public getSelfSubUrl ( $resource = null )

isShowAttributesInIncluded() 공개 메소드

프로퍼티 상세

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

protected bool $isShowAttributesInIncluded
리턴 boolean

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

protected string $resourceType
리턴 string

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

Must start with '/' e.g. '/sub-url'
protected $selfSubUrl