class ResourceObjectData in JSON:API 8.2
Represents the primary data for individual and collection documents.
@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.
Hierarchy
- class \Drupal\jsonapi\JsonApiResource\Data implements \Drupal\jsonapi\JsonApiResource\IteratorAggregate, \Drupal\jsonapi\JsonApiResource\Countable
- class \Drupal\jsonapi\JsonApiResource\ResourceObjectData
Expanded class hierarchy of ResourceObjectData
See also
https://www.drupal.org/project/jsonapi/issues/3032787
6 files declare their use of ResourceObjectData
- EntityResource.php in src/
Controller/ EntityResource.php - EntryPoint.php in src/
Controller/ EntryPoint.php - FileUpload.php in src/
Controller/ FileUpload.php - IncludeResolver.php in src/
IncludeResolver.php - JsonApiDocumentTopLevelNormalizerTest.php in tests/
src/ Kernel/ Normalizer/ JsonApiDocumentTopLevelNormalizerTest.php
File
- src/
JsonApiResource/ ResourceObjectData.php, line 17
Namespace
Drupal\jsonapi\JsonApiResourceView source
class ResourceObjectData extends Data {
/**
* ResourceObjectData constructor.
*
* @param \Drupal\jsonapi\JsonApiResource\ResourceObject[]|\Drupal\jsonapi\Exception\EntityAccessDeniedHttpException[] $data
* Resource objects that are the primary data for the response.
* @param int $cardinality
* The number of resources that this collection may contain.
*
* @see \Drupal\jsonapi\JsonApiResource\Data::__construct
*/
public function __construct($data, $cardinality = -1) {
assert(Inspector::assertAllObjects($data, ResourceObject::class, EntityAccessDeniedHttpException::class));
parent::__construct($data, $cardinality);
}
/**
* Gets only data to be exposed.
*
* @return static
*/
public function getAccessible() {
$accessible_data = [];
foreach ($this->data as $resource_object) {
if (!$resource_object instanceof EntityAccessDeniedHttpException) {
$accessible_data[] = $resource_object;
}
}
return new static($accessible_data, $this->cardinality);
}
/**
* Gets only data to be omitted.
*
* @return static
*/
public function getOmissions() {
$omitted_data = [];
foreach ($this->data as $resource_object) {
if ($resource_object instanceof EntityAccessDeniedHttpException) {
$omitted_data[] = $resource_object;
}
}
return new OmittedData($omitted_data);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Data:: |
protected | property | The number of resources permitted in this collection. | |
Data:: |
protected | property | Holds the total count of entities. | |
Data:: |
protected | property | Various representations of JSON:API objects. | |
Data:: |
protected | property | Holds a boolean indicating if there is a next page. | |
Data:: |
public | function | Returns the number of entities. | |
Data:: |
public static | function | Returns a new, deduplicated Data object. | |
Data:: |
public | function | Gets the cardinality of this collection. | |
Data:: |
public | function | Returns an iterator for entities. | |
Data:: |
public | function | ||
Data:: |
public | function | Checks if there is a next page in the collection. | |
Data:: |
public static | function | Returns a new Data object containing the entities of $this and $other. | |
Data:: |
public | function | Sets the has next page flag. | |
Data:: |
public | function | ||
Data:: |
public | function | Returns the collection as an array. | |
ResourceObjectData:: |
public | function | Gets only data to be exposed. | |
ResourceObjectData:: |
public | function | Gets only data to be omitted. | |
ResourceObjectData:: |
public | function |
ResourceObjectData constructor. Overrides Data:: |
2 |