class NullIncludedData

Same name in other branches
  1. 9 core/modules/jsonapi/src/JsonApiResource/NullIncludedData.php \Drupal\jsonapi\JsonApiResource\NullIncludedData
  2. 10 core/modules/jsonapi/src/JsonApiResource/NullIncludedData.php \Drupal\jsonapi\JsonApiResource\NullIncludedData
  3. 11.x core/modules/jsonapi/src/JsonApiResource/NullIncludedData.php \Drupal\jsonapi\JsonApiResource\NullIncludedData

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

Expanded class hierarchy of NullIncludedData

See also

https://www.drupal.org/project/drupal/issues/3032787

jsonapi.api.php

6 files declare their use of NullIncludedData
DefaultExceptionSubscriber.php in core/modules/jsonapi/src/EventSubscriber/DefaultExceptionSubscriber.php
EntityResource.php in core/modules/jsonapi/src/Controller/EntityResource.php
EntryPoint.php in core/modules/jsonapi/src/Controller/EntryPoint.php
FileUpload.php in core/modules/jsonapi/src/Controller/FileUpload.php
JsonApiDocumentTopLevelNormalizerTest.php in core/modules/jsonapi/tests/src/Kernel/Normalizer/JsonApiDocumentTopLevelNormalizerTest.php

... See full list

File

core/modules/jsonapi/src/JsonApiResource/NullIncludedData.php, line 14

Namespace

Drupal\jsonapi\JsonApiResource
View source 
class NullIncludedData extends IncludedData {
    
    /**
     * NullData constructor.
     */
    public function __construct() {
        parent::__construct([]);
    }

}

Members

Title Modifiers Object type Summary Overriden Title
Data::$cardinality protected property The number of resources permitted in this collection.
Data::$count protected property Holds the total count of entities.
Data::$data protected property Various representations of JSON:API objects.
Data::$hasNextPage protected property Holds a boolean indicating if there is a next page.
Data::count public function Returns the number of entities.
Data::deduplicate public static function Returns a new, deduplicated Data object.
Data::getCardinality public function Gets the cardinality of this collection.
Data::getIterator public function Returns an iterator for entities.
Data::getTotalCount public function
Data::hasNextPage public function Checks if there is a next page in the collection.
Data::merge public static function Returns a new Data object containing the entities of $this and $other.
Data::setHasNextPage public function Sets the has next page flag.
Data::setTotalCount public function
Data::toArray public function Returns the collection as an array.
NullIncludedData::__construct public function NullData constructor. Overrides IncludedData::__construct
ResourceObjectData::getAccessible public function Gets only data to be exposed.
ResourceObjectData::getData public function Returns the data for the top-level data member of a JSON:API document. Overrides TopLevelDataInterface::getData
ResourceObjectData::getMergedLinks public function Merges the object's links with the top-level links. Overrides TopLevelDataInterface::getMergedLinks
ResourceObjectData::getMergedMeta public function Merges the object's meta member with the top-level meta member. Overrides TopLevelDataInterface::getMergedMeta
ResourceObjectData::getOmissions public function Gets only data to be omitted. Overrides TopLevelDataInterface::getOmissions

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.