annotate core/modules/jsonapi/src/JsonApiResource/RelationshipData.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 namespace Drupal\jsonapi\JsonApiResource;
Chris@18 4
Chris@18 5 use Drupal\Component\Assertion\Inspector;
Chris@18 6
Chris@18 7 /**
Chris@18 8 * Represents the data of a relationship object or relationship document.
Chris@18 9 *
Chris@18 10 * @internal JSON:API maintains no PHP API. The API is the HTTP API. This class
Chris@18 11 * may change at any time and could break any dependencies on it.
Chris@18 12 *
Chris@18 13 * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18 14 * @see jsonapi.api.php
Chris@18 15 */
Chris@18 16 class RelationshipData extends Data {
Chris@18 17
Chris@18 18 /**
Chris@18 19 * RelationshipData constructor.
Chris@18 20 *
Chris@18 21 * @param \Drupal\jsonapi\JsonApiResource\ResourceIdentifier[] $data
Chris@18 22 * Resource objects that are the primary data for the response.
Chris@18 23 * @param int $cardinality
Chris@18 24 * The number of ResourceIdentifiers that this collection may contain.
Chris@18 25 *
Chris@18 26 * @see \Drupal\jsonapi\JsonApiResource\Data::__construct
Chris@18 27 */
Chris@18 28 public function __construct(array $data, $cardinality = -1) {
Chris@18 29 assert(Inspector::assertAllObjects($data, ResourceIdentifier::class));
Chris@18 30 parent::__construct($data, $cardinality);
Chris@18 31 }
Chris@18 32
Chris@18 33 }