public function EntityUuidConverter::convert in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/jsonapi/src/ParamConverter/EntityUuidConverter.php \Drupal\jsonapi\ParamConverter\EntityUuidConverter::convert()
2. 10 core/modules/jsonapi/src/ParamConverter/EntityUuidConverter.php \Drupal\jsonapi\ParamConverter\EntityUuidConverter::convert()

Converts path variables to their corresponding objects.

Parameters

mixed $value: The raw value.

mixed $definition: The parameter definition provided in the route options.

string $name: The name of the parameter.

array $defaults: The route defaults array.

Return value

mixed|null The converted parameter value.

Overrides EntityConverter::convert

File

core/modules/jsonapi/src/ParamConverter/EntityUuidConverter.php, line 49

Class

EntityUuidConverter

Parameter converter for upcasting entity UUIDs to full objects.

Namespace

Drupal\jsonapi\ParamConverter

Code

public function convert($value, $definition, $name, array $defaults) {
  $entity_type_id = $this
    ->getEntityTypeFromDefaults($definition, $name, $defaults);
  $uuid_key = $this->entityTypeManager
    ->getDefinition($entity_type_id)
    ->getKey('uuid');
  if ($storage = $this->entityTypeManager
    ->getStorage($entity_type_id)) {
    if (!($entities = $storage
      ->loadByProperties([
      $uuid_key => $value,
    ]))) {
      return NULL;
    }
    $entity = reset($entities);

    // If the entity type is translatable, ensure we return the proper
    // translation object for the current context.
    if ($entity instanceof TranslatableInterface && $entity
      ->isTranslatable()) {

      // @see https://www.drupal.org/project/drupal/issues/2624770
      $entity = $this->entityRepository
        ->getTranslationFromContext($entity, NULL, [
        'operation' => 'entity_upcast',
      ]);

      // JSON:API always has only one method per route.
      $method = $defaults[RouteObjectInterface::ROUTE_OBJECT]
        ->getMethods()[0];
      if (in_array($method, [
        'PATCH',
        'DELETE',
      ], TRUE)) {
        $current_content_language = $this->languageManager
          ->getCurrentLanguage(LanguageInterface::TYPE_CONTENT)
          ->getId();
        if ($method === 'DELETE' && (!$entity
          ->isDefaultTranslation() || $entity
          ->language()
          ->getId() !== $current_content_language)) {
          throw new MethodNotAllowedHttpException([
            'GET',
          ], 'Deleting a resource object translation is not yet supported. See https://www.drupal.org/docs/8/modules/jsonapi/translations.');
        }
        if ($method === 'PATCH' && $entity
          ->language()
          ->getId() !== $current_content_language) {
          $available_translations = implode(', ', array_keys($entity
            ->getTranslationLanguages()));
          throw new MethodNotAllowedHttpException([
            'GET',
          ], sprintf('The requested translation of the resource object does not exist, instead modify one of the translations that do exist: %s.', $available_translations));
        }
      }
    }
    return $entity;
  }
  return NULL;
}