class RelationshipData

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

Represents the data of a relationship object or relationship 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\RelationshipData extends \Drupal\jsonapi\JsonApiResource\Data

Expanded class hierarchy of RelationshipData

See also

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

jsonapi.api.php

File

core/modules/jsonapi/src/JsonApiResource/RelationshipData.php, line 16

Namespace

Drupal\jsonapi\JsonApiResource
View source 
class RelationshipData extends Data {
    
    /**
     * RelationshipData constructor.
     *
     * @param \Drupal\jsonapi\JsonApiResource\ResourceIdentifier[] $data
     *   Resource objects that are the primary data for the response.
     * @param int $cardinality
     *   The number of ResourceIdentifiers that this collection may contain.
     *
     * @see \Drupal\jsonapi\JsonApiResource\Data::__construct
     */
    public function __construct(array $data, $cardinality = -1) {
        assert(Inspector::assertAllObjects($data, ResourceIdentifier::class));
        parent::__construct($data, $cardinality);
    }

}

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.
RelationshipData::__construct public function RelationshipData constructor. Overrides Data::__construct

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