class IncludedData

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

Represents the included member of a 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

Expanded class hierarchy of IncludedData

See also

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

jsonapi.api.php

2 files declare their use of IncludedData
EntityResource.php in core/modules/jsonapi/src/Controller/EntityResource.php
IncludeResolver.php in core/modules/jsonapi/src/IncludeResolver.php

File

core/modules/jsonapi/src/JsonApiResource/IncludedData.php, line 17

Namespace

Drupal\jsonapi\JsonApiResource
View source 
class IncludedData extends ResourceObjectData {
    
    /**
     * IncludedData constructor.
     *
     * @param \Drupal\jsonapi\JsonApiResource\ResourceObject[]|\Drupal\jsonapi\Exception\EntityAccessDeniedHttpException[] $data
     *   Resource objects that are the primary data for the response.
     *
     * @see \Drupal\jsonapi\JsonApiResource\Data::__construct
     */
    public function __construct($data) {
        assert(Inspector::assertAllObjects($data, ResourceObject::class, EntityAccessDeniedHttpException::class));
        parent::__construct($data, -1);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
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.
IncludedData::__construct public function IncludedData constructor. Overrides ResourceObjectData::__construct 1
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.