RelationshipData.php in JSON:API 8.2

Namespace

Drupal\jsonapi\JsonApiResource

File

src/JsonApiResource/RelationshipData.php

<?php

namespace Drupal\jsonapi\JsonApiResource;

use Drupal\Component\Assertion\Inspector;

/**
 * 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.
 *
 * @see https://www.drupal.org/project/jsonapi/issues/3032787
 * @see jsonapi.api.php
 */
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);
  }

}

Classes

Name	Description
RelationshipData	Represents the data of a relationship object or relationship document.