Chris@18: <?php
Chris@18: 
Chris@18: namespace Drupal\jsonapi\JsonApiResource;
Chris@18: 
Chris@18: use Drupal\Core\Field\EntityReferenceFieldItemListInterface;
Chris@18: 
Chris@18: /**
Chris@18:  * Represents a JSON:API document's "top level".
Chris@18:  *
Chris@18:  * @internal JSON:API maintains no PHP API. The API is the HTTP API. This class
Chris@18:  *   may change at any time and could break any dependencies on it.
Chris@18:  *
Chris@18:  * @see https://www.drupal.org/project/jsonapi/issues/3032787
Chris@18:  * @see jsonapi.api.php
Chris@18:  *
Chris@18:  * @see http://jsonapi.org/format/#document-top-level
Chris@18:  *
Chris@18:  * @todo Add support for the missing optional 'jsonapi' member or document why not.
Chris@18:  */
Chris@18: class JsonApiDocumentTopLevel {
Chris@18: 
Chris@18:   /**
Chris@18:    * The data to normalize.
Chris@18:    *
Chris@18:    * @var \Drupal\jsonapi\JsonApiResource\ResourceIdentifierInterface|\Drupal\jsonapi\JsonApiResource\Data|\Drupal\jsonapi\JsonApiResource\ErrorCollection|\Drupal\Core\Field\EntityReferenceFieldItemListInterface
Chris@18:    */
Chris@18:   protected $data;
Chris@18: 
Chris@18:   /**
Chris@18:    * The metadata to normalize.
Chris@18:    *
Chris@18:    * @var array
Chris@18:    */
Chris@18:   protected $meta;
Chris@18: 
Chris@18:   /**
Chris@18:    * The links.
Chris@18:    *
Chris@18:    * @var \Drupal\jsonapi\JsonApiResource\LinkCollection
Chris@18:    */
Chris@18:   protected $links;
Chris@18: 
Chris@18:   /**
Chris@18:    * The includes to normalize.
Chris@18:    *
Chris@18:    * @var \Drupal\jsonapi\JsonApiResource\IncludedData
Chris@18:    */
Chris@18:   protected $includes;
Chris@18: 
Chris@18:   /**
Chris@18:    * Resource objects that will be omitted from the response for access reasons.
Chris@18:    *
Chris@18:    * @var \Drupal\jsonapi\JsonApiResource\OmittedData
Chris@18:    */
Chris@18:   protected $omissions;
Chris@18: 
Chris@18:   /**
Chris@18:    * Instantiates a JsonApiDocumentTopLevel object.
Chris@18:    *
Chris@18:    * @param \Drupal\jsonapi\JsonApiResource\ResourceIdentifierInterface|\Drupal\jsonapi\JsonApiResource\Data|\Drupal\jsonapi\JsonApiResource\ErrorCollection|\Drupal\Core\Field\EntityReferenceFieldItemListInterface $data
Chris@18:    *   The data to normalize. It can be either a ResourceObject, or a stand-in
Chris@18:    *   for one, or a collection of the same.
Chris@18:    * @param \Drupal\jsonapi\JsonApiResource\IncludedData $includes
Chris@18:    *   A JSON:API Data object containing resources to be included in the
Chris@18:    *   response document or NULL if there should not be includes.
Chris@18:    * @param \Drupal\jsonapi\JsonApiResource\LinkCollection $links
Chris@18:    *   A collection of links to resources related to the top-level document.
Chris@18:    * @param array $meta
Chris@18:    *   (optional) The metadata to normalize.
Chris@18:    */
Chris@18:   public function __construct($data, IncludedData $includes, LinkCollection $links, array $meta = []) {
Chris@18:     assert($data instanceof ResourceIdentifierInterface || $data instanceof Data || $data instanceof ErrorCollection || $data instanceof EntityReferenceFieldItemListInterface);
Chris@18:     assert(!$data instanceof ErrorCollection || $includes instanceof NullIncludedData);
Chris@18:     $this->data = $data instanceof ResourceObjectData ? $data->getAccessible() : $data;
Chris@18:     $this->includes = $includes->getAccessible();
Chris@18:     $this->links = $links->withContext($this);
Chris@18:     $this->meta = $meta;
Chris@18:     $this->omissions = $data instanceof ResourceObjectData
Chris@18:       ? OmittedData::merge($data->getOmissions(), $includes->getOmissions())
Chris@18:       : $includes->getOmissions();
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Gets the data.
Chris@18:    *
Chris@18:    * @return \Drupal\jsonapi\JsonApiResource\ResourceObject|\Drupal\jsonapi\JsonApiResource\Data|\Drupal\jsonapi\JsonApiResource\LabelOnlyResourceObject|\Drupal\jsonapi\JsonApiResource\ErrorCollection
Chris@18:    *   The data.
Chris@18:    */
Chris@18:   public function getData() {
Chris@18:     return $this->data;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Gets the links.
Chris@18:    *
Chris@18:    * @return \Drupal\jsonapi\JsonApiResource\LinkCollection
Chris@18:    *   The top-level links.
Chris@18:    */
Chris@18:   public function getLinks() {
Chris@18:     return $this->links;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Gets the metadata.
Chris@18:    *
Chris@18:    * @return array
Chris@18:    *   The metadata.
Chris@18:    */
Chris@18:   public function getMeta() {
Chris@18:     return $this->meta;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Gets a JSON:API Data object of resources to be included in the response.
Chris@18:    *
Chris@18:    * @return \Drupal\jsonapi\JsonApiResource\IncludedData
Chris@18:    *   The includes.
Chris@18:    */
Chris@18:   public function getIncludes() {
Chris@18:     return $this->includes;
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Gets an OmittedData instance containing resources to be omitted.
Chris@18:    *
Chris@18:    * @return \Drupal\jsonapi\JsonApiResource\OmittedData
Chris@18:    *   The omissions.
Chris@18:    */
Chris@18:   public function getOmissions() {
Chris@18:     return $this->omissions;
Chris@18:   }
Chris@18: 
Chris@18: }