PHP Interface Neomerx\JsonApi\Contracts\Schema\ResourceObjectInterface

Show file Open project: neomerx/json-api Interface Usage Examples

Public Methods

Method 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 method

Get resource attributes.
public getAttributes ( ) : array
return array

getId() public method

Get resource ID.
public getId ( ) : string
return string

getInclusionMeta() public method

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

getLinkageMeta() public method

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

getPrimaryMeta() public method

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

getRelationshipsInclusionMeta() public method

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

getRelationshipsPrimaryMeta() public method

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

getType() public method

Get resource type.
public getType ( ) : string
return string

isInArray() public method

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

isShowAttributesInIncluded() public method

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