Метод | Описание | |
---|---|---|
createResourceObject ( object $resource, boolean $isOriginallyArrayed, $attributeKeysFilter = null ) : Neomerx\JsonApi\Contracts\Schema\ResourceObjectInterface | Create resource object. | |
getAttributes ( object $resource ) : array | Get resource attributes. | |
getId ( object $resource ) : string | Get resource identity. | |
getIncludePaths ( ) : string[] | Get schema default include paths. | |
getIncludedResourceLinks ( mixed $resource ) : array | Get links related to resource when it is in 'included' section. | |
getInclusionMeta ( object $resource ) : mixed | Get meta when resource is within included resources. | |
getLinkageMeta ( object $resource ) : mixed | Get meta when resource is within relationship of a primary resource. | |
getPrimaryMeta ( object $resource ) : mixed | Get meta when resource is primary (top level 'data' section). | |
getRelationshipObjectIterator ( object $resource, boolean $isPrimary, array $includeRelationships ) : Iterator | Get resource's relationship objects. | |
getRelationshipRelatedLink ( object $resource, string $name, null | mixed $meta = null, boolean $treatAsHref = false ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | Get 'related' URL link to resource relationship. | |
getRelationshipSelfLink ( object $resource, string $name, null | mixed $meta = null, boolean $treatAsHref = false ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | Get 'self' URL link to resource relationship. | |
getRelationshipsInclusionMeta ( object $resource ) : mixed | Get get relationships meta when the resource is within included. | |
getRelationshipsPrimaryMeta ( object $resource ) : mixed | Get get relationships meta when the resource is primary. | |
getResourceLinks ( mixed $resource ) : array | Get links related to resource. | |
getResourceType ( ) : string | Get resource type. | |
getSelfSubLink ( object $resource ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | Get resource URL link. | |
getSelfSubUrl ( object | null $resource = null ) : string | Get resource sub URL. | |
isShowAttributesInIncluded ( ) : boolean | If resource attributes should be shown when the resource is within 'included'. |
public createResourceObject ( object $resource, boolean $isOriginallyArrayed, $attributeKeysFilter = null ) : Neomerx\JsonApi\Contracts\Schema\ResourceObjectInterface | ||
$resource | object | |
$isOriginallyArrayed | boolean | |
Результат | Neomerx\JsonApi\Contracts\Schema\ResourceObjectInterface |
public getAttributes ( object $resource ) : array | ||
$resource | object | |
Результат | array |
public getIncludePaths ( ) : string[] | ||
Результат | string[] |
public getIncludedResourceLinks ( mixed $resource ) : array | ||
$resource | mixed | |
Результат | array | Array key is link name and value is LinkInterface. |
public getInclusionMeta ( object $resource ) : mixed | ||
$resource | object | |
Результат | mixed |
public getLinkageMeta ( object $resource ) : mixed | ||
$resource | object | |
Результат | mixed |
public getPrimaryMeta ( object $resource ) : mixed | ||
$resource | object | |
Результат | mixed |
public getRelationshipRelatedLink ( object $resource, string $name, null | mixed $meta = null, boolean $treatAsHref = false ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | ||
$resource | object | |
$name | string | |
$meta | null | mixed | |
$treatAsHref | boolean | |
Результат | Neomerx\JsonApi\Contracts\Document\LinkInterface |
public getRelationshipSelfLink ( object $resource, string $name, null | mixed $meta = null, boolean $treatAsHref = false ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | ||
$resource | object | |
$name | string | |
$meta | null | mixed | |
$treatAsHref | boolean | |
Результат | Neomerx\JsonApi\Contracts\Document\LinkInterface |
public getRelationshipsInclusionMeta ( object $resource ) : mixed | ||
$resource | object | |
Результат | mixed |
public getRelationshipsPrimaryMeta ( object $resource ) : mixed | ||
$resource | object | |
Результат | mixed |
public getResourceLinks ( mixed $resource ) : array | ||
$resource | mixed | |
Результат | array | Array key is link name and value is LinkInterface. |
public getResourceType ( ) : string | ||
Результат | string |
public getSelfSubLink ( object $resource ) : Neomerx\JsonApi\Contracts\Document\LinkInterface | ||
$resource | object | |
Результат | Neomerx\JsonApi\Contracts\Document\LinkInterface |
public isShowAttributesInIncluded ( ) : boolean | ||
Результат | boolean |