class NullIncludedData in JSON:API 8.2
Use when there are no included resources but a Data object is required.
@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
- class \Drupal\jsonapi\JsonApiResource\IncludedData
- class \Drupal\jsonapi\JsonApiResource\NullIncludedData
- class \Drupal\jsonapi\JsonApiResource\IncludedData
- class \Drupal\jsonapi\JsonApiResource\ResourceObjectData
Expanded class hierarchy of NullIncludedData
See also
https://www.drupal.org/project/jsonapi/issues/3032787
6 files declare their use of NullIncludedData
- DefaultExceptionSubscriber.php in src/
EventSubscriber/ DefaultExceptionSubscriber.php - EntityResource.php in src/
Controller/ EntityResource.php - EntryPoint.php in src/
Controller/ EntryPoint.php - FileUpload.php in src/
Controller/ FileUpload.php - JsonApiDocumentTopLevelNormalizerTest.php in tests/
src/ Kernel/ Normalizer/ JsonApiDocumentTopLevelNormalizerTest.php
File
- src/
JsonApiResource/ NullIncludedData.php, line 14
Namespace
Drupal\jsonapi\JsonApiResourceView source
class NullIncludedData extends IncludedData {
/**
* NullData constructor.
*/
public function __construct() {
parent::__construct([]);
}
}
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. | |
NullIncludedData:: |
public | function |
NullData constructor. Overrides IncludedData:: |
|
ResourceObjectData:: |
public | function | Gets only data to be exposed. | |
ResourceObjectData:: |
public | function | Gets only data to be omitted. |