class EntityUuidConverter in Drupal 8
Same name and namespace in other branches
- 9 core/modules/jsonapi/src/ParamConverter/EntityUuidConverter.php \Drupal\jsonapi\ParamConverter\EntityUuidConverter
Parameter converter for upcasting entity UUIDs to full objects.
@internal JSON:API maintains no PHP API since its API is the HTTP API. This class may change at any time and this will break any dependencies on it.
@todo Remove when https://www.drupal.org/node/2353611 lands.
Hierarchy
- class \Drupal\Core\ParamConverter\EntityConverter implements ParamConverterInterface uses DeprecatedServicePropertyTrait, DynamicEntityTypeParamConverterTrait
- class \Drupal\jsonapi\ParamConverter\EntityUuidConverter
Expanded class hierarchy of EntityUuidConverter
See also
https://www.drupal.org/project/drupal/issues/3032787
\Drupal\Core\ParamConverter\EntityConverter
1 string reference to 'EntityUuidConverter'
- jsonapi.services.yml in core/
modules/ jsonapi/ jsonapi.services.yml - core/modules/jsonapi/jsonapi.services.yml
1 service uses EntityUuidConverter
- paramconverter.jsonapi.entity_uuid in core/
modules/ jsonapi/ jsonapi.services.yml - Drupal\jsonapi\ParamConverter\EntityUuidConverter
File
- core/
modules/ jsonapi/ src/ ParamConverter/ EntityUuidConverter.php, line 27
Namespace
Drupal\jsonapi\ParamConverterView source
class EntityUuidConverter extends EntityConverter {
/**
* The language manager.
*
* @var \Drupal\Core\Language\LanguageManagerInterface
*/
protected $languageManager;
/**
* Injects the language manager.
*
* @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
* The language manager to get the current content language.
*/
public function setLanguageManager(LanguageManagerInterface $language_manager) {
$this->languageManager = $language_manager;
}
/**
* {@inheritdoc}
*/
public function convert($value, $definition, $name, array $defaults) {
$entity_type_id = $this
->getEntityTypeFromDefaults($definition, $name, $defaults);
// @see https://www.drupal.org/project/drupal/issues/2624770
$entity_type_manager = isset($this->entityTypeManager) ? $this->entityTypeManager : $this->entityManager;
$uuid_key = $entity_type_manager
->getDefinition($entity_type_id)
->getKey('uuid');
if ($storage = $entity_type_manager
->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_repository = isset($this->entityRepository) ? $this->entityRepository : $this->entityManager;
$entity = $entity_repository
->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;
}
/**
* {@inheritdoc}
*/
public function applies($definition, $name, Route $route) {
return (bool) Routes::getResourceTypeNameFromParameters($route
->getDefaults()) && !empty($definition['type']) && strpos($definition['type'], 'entity') === 0;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DeprecatedServicePropertyTrait:: |
public | function | Allows to access deprecated/removed properties. | |
DynamicEntityTypeParamConverterTrait:: |
protected | function | Determines the entity type ID given a route definition and route defaults. | |
EntityConverter:: |
protected | property | ||
EntityConverter:: |
protected | property | Entity repository. | |
EntityConverter:: |
protected | property | Entity type manager which performs the upcasting in the end. | |
EntityConverter:: |
protected | function | Returns the latest revision translation of the specified entity. | |
EntityConverter:: |
protected | function | Returns a language manager instance. | |
EntityConverter:: |
protected | function | Loads the specified entity revision. | |
EntityConverter:: |
public | function | Constructs a new EntityConverter. | 1 |
EntityUuidConverter:: |
protected | property | The language manager. | |
EntityUuidConverter:: |
public | function |
Determines if the converter applies to a specific route and variable. Overrides EntityConverter:: |
|
EntityUuidConverter:: |
public | function |
Converts path variables to their corresponding objects. Overrides EntityConverter:: |
|
EntityUuidConverter:: |
public | function | Injects the language manager. |