class OmittedData in Drupal 8
Same name and namespace in other branches
- 9 core/modules/jsonapi/src/JsonApiResource/OmittedData.php \Drupal\jsonapi\JsonApiResource\OmittedData
Represents resource data that should be omitted from the JSON:API document.
@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 implements TopLevelDataInterface
- class \Drupal\jsonapi\JsonApiResource\OmittedData
- class \Drupal\jsonapi\JsonApiResource\ResourceObjectData implements TopLevelDataInterface
Expanded class hierarchy of OmittedData
See also
https://www.drupal.org/project/drupal/issues/3032787
1 file declares its use of OmittedData
- JsonApiDocumentTopLevelNormalizer.php in core/
modules/ jsonapi/ src/ Normalizer/ JsonApiDocumentTopLevelNormalizer.php
File
- core/
modules/ jsonapi/ src/ JsonApiResource/ OmittedData.php, line 17
Namespace
Drupal\jsonapi\JsonApiResourceView source
class OmittedData extends ResourceObjectData {
/**
* OmittedData constructor.
*
* @param \Drupal\jsonapi\Exception\EntityAccessDeniedHttpException[] $data
* Resource objects that are the primary data for the response.
*
* @see \Drupal\jsonapi\JsonApiResource\Data::__construct
*/
public function __construct(array $data) {
assert(Inspector::assertAllObjects($data, EntityAccessDeniedHttpException::class));
parent::__construct($data, -1);
}
}
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. | |
OmittedData:: |
public | function |
OmittedData constructor. Overrides ResourceObjectData:: |
|
ResourceObjectData:: |
public | function | Gets only data to be exposed. | |
ResourceObjectData:: |
public | function |
Returns the data for the top-level data member of a JSON:API document. Overrides TopLevelDataInterface:: |
|
ResourceObjectData:: |
public | function |
Merges the object's links with the top-level links. Overrides TopLevelDataInterface:: |
|
ResourceObjectData:: |
public | function |
Merges the object's meta member with the top-level meta member. Overrides TopLevelDataInterface:: |
|
ResourceObjectData:: |
public | function |
Gets only data to be omitted. Overrides TopLevelDataInterface:: |