PHP Interface Neomerx\JsonApi\Contracts\Schema\ResourceObjectInterface

Afficher le fichier Open project: neomerx/json-api Interface Usage Examples

Méthodes publiques

Méthode Description
getAttributes ( ) : array Get resource attributes.
getId ( ) : string Get resource ID.
getIncludedResourceLinks ( ) : array Get links related to resource when it is in 'included' section.
getInclusionMeta ( ) : array | object | null Get meta-information about resource object.
getLinkageMeta ( ) : array | object | null Get meta-information about resource object.
getPrimaryMeta ( ) : array | object | null Get meta-information about resource object.
getRelationshipsInclusionMeta ( ) : array | object | null Get meta-information about resource relationships when resource is included.
getRelationshipsPrimaryMeta ( ) : array | object | null Get meta-information about resource relationships when resource is primary.
getResourceLinks ( ) : array Get links related to resource.
getSelfSubLink ( ) : Neomerx\JsonApi\Contracts\Document\LinkInterface Get resource 'self' endpoint URL.
getType ( ) : string Get resource type.
isInArray ( ) : boolean If original data we part of an array of elements.
isShowAttributesInIncluded ( ) : boolean If resource attributes should be shown when the resource is within 'included'.

Method Details

getAttributes() public méthode

Get resource attributes.
public getAttributes ( ) : array
Résultat array

getId() public méthode

Get resource ID.
public getId ( ) : string
Résultat string

getInclusionMeta() public méthode

Get meta-information about resource object.
public getInclusionMeta ( ) : array | object | null
Résultat array | object | null

getLinkageMeta() public méthode

Get meta-information about resource object.
public getLinkageMeta ( ) : array | object | null
Résultat array | object | null

getPrimaryMeta() public méthode

Get meta-information about resource object.
public getPrimaryMeta ( ) : array | object | null
Résultat array | object | null

getRelationshipsInclusionMeta() public méthode

Get meta-information about resource relationships when resource is included.
public getRelationshipsInclusionMeta ( ) : array | object | null
Résultat array | object | null

getRelationshipsPrimaryMeta() public méthode

Get meta-information about resource relationships when resource is primary.
public getRelationshipsPrimaryMeta ( ) : array | object | null
Résultat array | object | null

getType() public méthode

Get resource type.
public getType ( ) : string
Résultat string

isInArray() public méthode

If original data we part of an array of elements.
public isInArray ( ) : boolean
Résultat boolean

isShowAttributesInIncluded() public méthode

If resource attributes should be shown when the resource is within 'included'.
public isShowAttributesInIncluded ( ) : boolean
Résultat boolean