class RelationshipData in Drupal 9
Same name and namespace in other branches
- 8 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
Expanded class hierarchy of RelationshipData
See also
https://www.drupal.org/project/drupal/issues/3032787
File
- core/
modules/ jsonapi/ src/ JsonApiResource/ RelationshipData.php, line 16
Namespace
Drupal\jsonapi\JsonApiResourceView 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
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. | |
RelationshipData:: |
public | function |
RelationshipData constructor. Overrides Data:: |