class OmittedData

Represents resource data that should be omitted from the 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

• class \Drupal\jsonapi\JsonApiResource\Data implements \Drupal\jsonapi\JsonApiResource\IteratorAggregate, \Drupal\jsonapi\JsonApiResource\Countable
  • class \Drupal\jsonapi\JsonApiResource\ResourceObjectData implements \Drupal\jsonapi\JsonApiResource\TopLevelDataInterface extends \Drupal\jsonapi\JsonApiResource\Data
    • class \Drupal\jsonapi\JsonApiResource\OmittedData extends \Drupal\jsonapi\JsonApiResource\ResourceObjectData

Expanded class hierarchy of OmittedData

See also

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

jsonapi.api.php

File

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

Namespace

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

}