1. class
  2. Drupal
  3. \
  4. jsonapi
  5. \
  6. JsonApiResource
  7. \
  8. ResourceObjectData

ResourceObjectData

class ResourceObjectData extends Data implements TopLevelDataInterface (View source)

internal  JSON:API maintains no PHP API. The API is the HTTP API. This class may change at any time and could break any dependencies on it.
 

Represents the primary data for individual and collection documents.

Properties

protected ResourceIdentifierInterface[] $data

Various representations of JSON:API objects.

 from  Data
protected int $cardinality

The number of resources permitted in this collection.

 from  Data
protected bool $hasNextPage

Holds a boolean indicating if there is a next page.

 from  Data
protected int $count

Holds the total count of entities.

 from  Data

Methods

__construct(array $data, int $cardinality = -1)

ResourceObjectData constructor.

ArrayIterator
getIterator()

Returns an iterator for entities.

from  Data
int
count()

Returns the number of entities.

from  Data
getTotalCount()

{@inheritdoc}

from  Data
setTotalCount($count)

{@inheritdoc}

from  Data
EntityInterface[]
toArray()

Returns the collection as an array.

from  Data
bool
hasNextPage()

Checks if there is a next page in the collection.

from  Data
setHasNextPage(bool $has_next_page)

Sets the has next page flag.

from  Data
int
getCardinality()

Gets the cardinality of this collection.

from  Data
static Data
merge(Data $a, Data $b)

Returns a new Data object containing the entities of $this and $other.

from  Data
static Data
deduplicate(Data $collection)

Returns a new, deduplicated Data object.

from  Data
Data
getData()

Returns the data for the top-level data member of a JSON:API document.

ResourceObjectData
getAccessible()

Gets only data to be exposed.

OmittedData
getOmissions()

Gets only data to be omitted.

LinkCollection
getMergedLinks(LinkCollection $top_level_links)

Merges the object's links with the top-level links.

array
getMergedMeta(array $top_level_meta)

Merges the object's meta member with the top-level meta member.

Details

at line 29
__construct(array $data, int $cardinality = -1)

ResourceObjectData constructor.

Parameters

array $data

The resources or resource identifiers for the collection.
int $cardinality

The number of resources that this collection may contain. Related resource collections may handle both to-one or to-many relationships. A to-one relationship should have a cardinality of 1. Use -1 for unlimited cardinality.

See also

Data::__construct

in Data at line 72
ArrayIterator getIterator()

Returns an iterator for entities.

Return Value

ArrayIterator

An \ArrayIterator instance

in Data at line 83
int count()

Returns the number of entities.

Return Value

int

The number of parameters

in Data at line 91
getTotalCount()

{@inheritdoc}

in Data at line 98
setTotalCount($count)

{@inheritdoc}

Parameters

$count

in Data at line 108
EntityInterface[] toArray()

Returns the collection as an array.

Return Value

EntityInterface[]

The array of entities.

in Data at line 118
bool hasNextPage()

Checks if there is a next page in the collection.

Return Value

bool

TRUE if the collection has a next page.

in Data at line 131
setHasNextPage(bool $has_next_page)

Sets the has next page flag.

Once the collection query has been executed and we build the entity collection, we now if there will be a next page with extra entities.

Parameters

bool $has_next_page

TRUE if the collection has a next page.

in Data at line 141
int getCardinality()

Gets the cardinality of this collection.

Return Value

int

The cardinality of the resource collection. -1 for unlimited cardinality.

in Data at line 156
static Data merge(Data $a, Data $b)

Returns a new Data object containing the entities of $this and $other.

Parameters

Data $a

A Data object object to be merged.
Data $b

A Data object to be merged.

Return Value

Data

A new merged Data object.

in Data at line 169
static Data deduplicate(Data $collection)

Returns a new, deduplicated Data object.

Parameters

Data $collection

The Data object to deduplicate.

Return Value

Data

A new merged Data object.

at line 37
Data getData()

Returns the data for the top-level data member of a JSON:API document.

Return Value

Data

The top-level data.

at line 46
ResourceObjectData getAccessible()

Gets only data to be exposed.

Return Value

ResourceObjectData

at line 61
OmittedData getOmissions()

Gets only data to be omitted.

Return Value

OmittedData

The omitted data.

Merges the object's links with the top-level links.

Parameters

LinkCollection $top_level_links

The top-level links to merge.

Return Value

LinkCollection

The merged links.

at line 81
array getMergedMeta(array $top_level_meta)

Merges the object's meta member with the top-level meta member.

Parameters

array $top_level_meta

The top-level links to merge.

Return Value

array

The merged meta member.