ResourceObjectData.php

<?php

namespace Drupal\jsonapi\JsonApiResource;

use Drupal\Component\Assertion\Inspector;
use Drupal\jsonapi\Exception\EntityAccessDeniedHttpException;

/**
 * Represents the primary data for individual and collection documents.
 *
 * @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/drupal/issues/3032787
 * @see jsonapi.api.php
 */
class ResourceObjectData extends Data implements TopLevelDataInterface {
    
    /**
     * ResourceObjectData constructor.
     *
     * @param \Drupal\jsonapi\JsonApiResource\ResourceObject[]|\Drupal\jsonapi\Exception\EntityAccessDeniedHttpException[] $data
     *   Resource objects that are the primary data for the response.
     * @param int $cardinality
     *   The number of resources that this collection may contain.
     *
     * @see \Drupal\jsonapi\JsonApiResource\Data::__construct
     */
    public function __construct($data, $cardinality = -1) {
        assert(Inspector::assertAllObjects($data, ResourceObject::class, EntityAccessDeniedHttpException::class));
        parent::__construct($data, $cardinality);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getData() {
        return $this->getAccessible();
    }
    
    /**
     * Gets only data to be exposed.
     *
     * @return static
     */
    public function getAccessible() {
        $accessible_data = [];
        foreach ($this->data as $resource_object) {
            if (!$resource_object instanceof EntityAccessDeniedHttpException) {
                $accessible_data[] = $resource_object;
            }
        }
        return new static($accessible_data, $this->cardinality);
    }
    
    /**
     * Gets only data to be omitted.
     *
     * @return static
     */
    public function getOmissions() {
        $omitted_data = [];
        foreach ($this->data as $resource_object) {
            if ($resource_object instanceof EntityAccessDeniedHttpException) {
                $omitted_data[] = $resource_object;
            }
        }
        return new OmittedData($omitted_data);
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMergedLinks(LinkCollection $top_level_links) {
        return $top_level_links;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getMergedMeta(array $top_level_meta) {
        return $top_level_meta;
    }

}