[ Index ]

PHP Cross Reference of Joomla 4.2.2 documentation

title

Body

[close]

/libraries/vendor/tobscure/json-api/src/ -> Resource.php (summary)

(no description)

File Size: 406 lines (9 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Resource:: (24 methods):
  __construct()
  getResources()
  toArray()
  isIdentifier()
  toIdentifier()
  getType()
  getId()
  getAttributes()
  getOwnFields()
  filterFields()
  mergeAttributes()
  getRelationships()
  getUnfilteredRelationships()
  getRelationshipsAsArray()
  buildRelationships()
  mergeRelationships()
  convertRelationshipsToArray()
  merge()
  with()
  fields()
  getData()
  setData()
  getSerializer()
  setSerializer()


Class: Resource  - X-Ref

__construct($data, SerializerInterface $serializer)   X-Ref

param: mixed $data
param: \Tobscure\JsonApi\SerializerInterface $serializer

getResources()   X-Ref
{@inheritdoc}


toArray()   X-Ref
{@inheritdoc}


isIdentifier()   X-Ref
Check whether or not this resource is an identifier (i.e. does it have
any data attached?).

return: bool

toIdentifier()   X-Ref
{@inheritdoc}


getType()   X-Ref
Get the resource type.

return: string

getId()   X-Ref
Get the resource ID.

return: string

getAttributes()   X-Ref
Get the resource attributes.

return: array

getOwnFields()   X-Ref
Get the requested fields for this resource type.

return: array|null

filterFields(array $fields)   X-Ref
Filter the given fields array (attributes or relationships) according
to the requested fieldset.

param: array $fields
return: array

mergeAttributes(array $attributes)   X-Ref
Merge the attributes of merged resources into an array of attributes.

param: array $attributes
return: array

getRelationships()   X-Ref
Get the resource relationships.

return: \Tobscure\JsonApi\Relationship[]

getUnfilteredRelationships()   X-Ref
Get the resource relationships without considering requested ones.

return: \Tobscure\JsonApi\Relationship[]

getRelationshipsAsArray()   X-Ref
Get the resource relationships as an array.

return: array

buildRelationships()   X-Ref
Get an array of built relationships.

return: \Tobscure\JsonApi\Relationship[]

mergeRelationships(array $relationships)   X-Ref
Merge the relationships of merged resources into an array of
relationships.

param: array $relationships
return: array

convertRelationshipsToArray(array $relationships)   X-Ref
Convert the given array of Relationship objects into an array.

param: \Tobscure\JsonApi\Relationship[] $relationships
return: array

merge(Resource $resource)   X-Ref
Merge a resource into this one.

param: \Tobscure\JsonApi\Resource $resource
return: void

with($relationships)   X-Ref
{@inheritdoc}


fields($fields)   X-Ref
{@inheritdoc}


getData()   X-Ref

return: mixed

setData($data)   X-Ref

param: mixed $data
return: void

getSerializer()   X-Ref

return: \Tobscure\JsonApi\SerializerInterface

setSerializer(SerializerInterface $serializer)   X-Ref

param: \Tobscure\JsonApi\SerializerInterface $serializer
return: void



Generated: Wed Sep 7 05:41:13 2022 Chilli.vc Blog - For Webmaster,Blog-Writer,System Admin and Domainer