You are here

Home » API reference » JSON:API Extras 8.3 » EntityResource.php

class EntityResource in JSON:API Extras 8.3

Overrides jsonapi module EntityResource controller.

Hierarchy

Expanded class hierarchy of EntityResource

File

modules/jsonapi_defaults/src/Controller/EntityResource.php, line 17

Namespace

Drupal\jsonapi_defaults\Controller
View source 
class EntityResource extends JsonApiEntityResourse {

  /**
   * {@inheritdoc}
   */
  protected function getJsonApiParams(Request $request, ResourceType $resource_type) {

    // If this is a related resource, then we need to swap to the new resource
    // type.
    $related_field = $request->attributes
      ->get('_on_relationship') ? NULL : $request->attributes
      ->get('related');
    try {
      $resource_type = static::correctResourceTypeOnRelated($related_field, $resource_type);
    } catch (\LengthException $e) {
      watchdog_exception('jsonapi_defaults', $e);
      $resource_type = NULL;
    }
    if (!$resource_type instanceof ConfigurableResourceType) {
      return parent::getJsonApiParams($request, $resource_type);
    }
    $resource_config = $resource_type
      ->getJsonapiResourceConfig();
    if (!$resource_config instanceof JsonapiResourceConfig) {
      return parent::getJsonApiParams($request, $resource_type);
    }
    $default_filter_input = $resource_config
      ->getThirdPartySetting('jsonapi_defaults', 'default_filter', []);
    $default_sorting_input = $resource_config
      ->getThirdPartySetting('jsonapi_defaults', 'default_sorting', []);
    $default_filter = [];
    $default_sorting = [];
    foreach ($default_filter_input as $key => $value) {
      if (substr($key, 0, 6) === 'filter') {
        $key = str_replace('filter:', '', $key);

        // @todo Replace this with use of the NestedArray utility.
        $this
          ->setFilterValue($default_filter, $key, $value);
      }
    }
    foreach ($default_sorting_input as $key => $value) {
      if (substr($key, 0, 4) === 'sort') {
        $key = str_replace('sort:', '', $key);

        // @todo Replace this with use of the NestedArray utility.
        $this
          ->setFilterValue($default_sorting, $key, $value);
      }
    }
    $filters = array_merge($default_filter, $request->query
      ->get('filter', []));
    $sorting = array_merge($default_sorting, $request->query
      ->get('sort', []));
    if (!empty($filters)) {
      $request->query
        ->set('filter', $filters);
    }
    if (!empty($sorting)) {
      $request->query
        ->set('sort', $sorting);
    }

    // Implements overridden page limits.
    $params = parent::getJsonApiParams($request, $resource_type);
    $this
      ->setPageLimit($request, $resource_config, $params);
    return $params;
  }

  /**
   * {@inheritdoc}
   */
  public function getIncludes(Request $request, $data) {

    /** @var \Drupal\jsonapi_extras\ResourceType\ConfigurableResourceType $resourceConfig */
    if (($resource_type = $request
      ->get(Routes::RESOURCE_TYPE_KEY)) && $resource_type instanceof ConfigurableResourceType && !$request
      ->get('_on_relationship')) {
      try {
        $resource_type = static::correctResourceTypeOnRelated($request
          ->get('related'), $resource_type);
      } catch (\LengthException $e) {
        watchdog_exception('jsonapi_defaults', $e);
        return parent::getIncludes($request, $data);
      }
      if (!$resource_type instanceof ConfigurableResourceType) {
        return parent::getIncludes($request, $data);
      }
      $resource_config = $resource_type
        ->getJsonapiResourceConfig();
      if (!$resource_config instanceof JsonapiResourceConfig) {
        return parent::getIncludes($request, $data);
      }
      $default_includes = $resource_config
        ->getThirdPartySetting('jsonapi_defaults', 'default_include', []);
      if (!empty($default_includes) && $request->query
        ->get('include') === NULL) {
        $includes = array_unique(array_filter(array_merge($default_includes, explode(',', $request->query
          ->get('include', '')))));
        $request->query
          ->set('include', implode(',', $includes));
      }
    }
    return parent::getIncludes($request, $data);
  }

  /**
   * Returns the correct resource type when operating on related fields.
   *
   * @param string $related_field
   *   The name of the related field to use. NULL if not using a related field.
   * @param \Drupal\jsonapi\ResourceType\ResourceType $resource_type
   *   The resource type straight from the request.
   *
   * @return \Drupal\jsonapi\ResourceType\ResourceType
   *   The resource type to use to load the includes.
   *
   * @throws \LengthException
   *   If there is more than one relatable resource type.
   */
  public static function correctResourceTypeOnRelated($related_field, ResourceType $resource_type) {
    if (!$related_field) {
      return $resource_type;
    }
    $relatable_resource_types = $resource_type
      ->getRelatableResourceTypesByField($related_field);
    if (count($relatable_resource_types) > 1) {
      $message = sprintf('%s -- %s', 'Impossible to apply defaults on a related resource with heterogeneous resource types.', Json::encode([
        'related_field' => $related_field,
        'host_resource_type' => $resource_type
          ->getPath(),
        'target_resource_types' => array_map(function (ResourceType $resource_type) {
          return $resource_type
            ->getPath();
        }, $relatable_resource_types),
      ]));
      throw new \LengthException($message);
    }
    return isset($relatable_resource_types[0]) ? $relatable_resource_types[0] : NULL;
  }

  /**
   * Set filter into nested array.
   *
   * @param array $arr
   *   The default filter.
   * @param string $path
   *   The filter path.
   * @param mixed $value
   *   The filter value.
   */
  private function setFilterValue(array &$arr, $path, $value) {
    $keys = explode('#', $path);
    foreach ($keys as $key) {
      $arr =& $arr[$key];
    }
    $arr = $value;
  }

  /**
   * Get amount of items displayed per page considering the request query.
   *
   * Fall back to the JSON:API standard value of 50 if not customized.
   *
   * @param array $page_params
   *   The values of the page query parameter of the request.
   * @param Drupal\jsonapi_extras\Entity\JsonapiResourceConfig $resource_config
   *   This resource's config entity.
   *
   * @return int
   *   Max number of items.
   */
  protected function determinePageLimit(array $page_params, JsonapiResourceConfig $resource_config) {
    $query_limit = !empty($page_params['limit']) ? (int) $page_params['limit'] : OffsetPage::SIZE_MAX;
    $page_limit = $resource_config
      ->getThirdPartySetting('jsonapi_defaults', 'page_limit') ?: OffsetPage::SIZE_MAX;
    return min($query_limit, (int) $page_limit);
  }

  /**
   * Sets a jsonapi parameter for the page limit if applicable.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param \Drupal\jsonapi_extras\Entity\JsonapiResourceConfig $resource_config
   *   The resource config entity to check for an override of the page limit.
   * @param array $params
   *   The parameters passed to jsonapi, passed by reference.
   */
  protected function setPageLimit(Request $request, JsonapiResourceConfig $resource_config, array &$params) {
    if ($request->query
      ->has('page')) {
      $page_params = $request->query
        ->get('page');
      $offset = array_key_exists(OffsetPage::OFFSET_KEY, $page_params) ? (int) $page_params[OffsetPage::OFFSET_KEY] : OffsetPage::DEFAULT_OFFSET;
      $params[OffsetPage::KEY_NAME] = new OffsetPage($offset, $this
        ->determinePageLimit($page_params, $resource_config));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
EntityResource::$entityAccessChecker protected property The JSON:API entity access checker.
EntityResource::$entityRepository protected property The entity repository.
EntityResource::$entityTypeManager protected property The entity type manager.
EntityResource::$fieldManager protected property The field manager.
EntityResource::$fieldResolver protected property The JSON:API field resolver.
EntityResource::$includeResolver protected property The include resolver.
EntityResource::$renderer protected property The renderer.
EntityResource::$resourceTypeRepository protected property The resource type repository.
EntityResource::$serializer protected property The JSON:API serializer.
EntityResource::$time protected property The time service.
EntityResource::$user protected property The current user account.
EntityResource::addToRelationshipData public function Adds a relationship to a to-many relationship.
EntityResource::buildWrappedResponse protected function Builds a response with the appropriate wrapped document.
EntityResource::checkPatchFieldAccess protected function Checks whether the given field should be PATCHed.
EntityResource::correctResourceTypeOnRelated public static function Returns the correct resource type when operating on related fields.
EntityResource::createIndividual public function Creates an individual entity.
EntityResource::deleteIndividual public function Deletes an individual entity.
EntityResource::deserialize protected function Deserializes a request body, if any.
EntityResource::determinePageLimit protected function Get amount of items displayed per page considering the request query.
EntityResource::doPatchIndividualRelationship protected function Update a to-one relationship.
EntityResource::doPatchMultipleRelationship protected function Update a to-many relationship.
EntityResource::entityExists protected function Checks if the given entity exists.
EntityResource::executeQueryInRenderContext protected function Executes the query in a render context, to catch bubbled cacheability.
EntityResource::getCollection public function Gets the collection of entities.
EntityResource::getCollectionCountQuery protected function Gets a basic query for a collection count.
EntityResource::getCollectionQuery protected function Gets a basic query for a collection.
EntityResource::getEntityFromResourceIdentifier protected function Loads the entity targeted by a resource identifier.
EntityResource::getIncludes public function Gets includes for the given response data. Overrides EntityResource::getIncludes
EntityResource::getIndividual public function Gets the individual entity.
EntityResource::getJsonApiParams protected function Extracts JSON:API query parameters from the request. Overrides EntityResource::getJsonApiParams
EntityResource::getPagerLinks protected static function Get the pager links for a given request object.
EntityResource::getPagerQueries protected static function Get the query param array.
EntityResource::getRelated public function Gets the related resource.
EntityResource::getRelationship public function Gets the relationship of an entity.
EntityResource::getRequestLink protected static function Get the full URL for a given request object.
EntityResource::loadEntitiesWithAccess protected function Build a collection of the entities to respond with and access objects.
EntityResource::patchIndividual public function Patches an individual entity.
EntityResource::relationshipResponseRequiresBody protected static function Determines if the client needs to be updated with new relationship data.
EntityResource::removeFromRelationshipData public function Deletes the relationship of an entity.
EntityResource::replaceRelationshipData public function Updates the relationship of an entity.
EntityResource::respondWithCollection protected function Respond with an entity collection.
EntityResource::setFilterValue private function Set filter into nested array.
EntityResource::setPageLimit protected function Sets a jsonapi parameter for the page limit if applicable.
EntityResource::updateEntityField protected function Takes a field from the origin entity and puts it to the destination entity.
EntityResource::__construct public function Instantiates a EntityResource object.
EntityValidationTrait::validate protected static function Verifies that an entity does not violate any validation constraints.