1. class
  2. Drupal
  3. \
  4. jsonapi
  5. \
  6. ParamConverter
  7. \
  8. EntityUuidConverter

EntityUuidConverter

class EntityUuidConverter extends EntityConverter (View source)

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.
 

Parameter converter for upcasting entity UUIDs to full objects.

Remove when https://www.drupal.org/node/2353611 lands.

Traits

DeprecatedServicePropertyTrait

Provides a standard way to announce deprecated properties.

DynamicEntityTypeParamConverterTrait

Provides a trait to replace dynamic entity types in routes.

Properties

protected $deprecatedProperties {@inheritdoc} from  EntityConverter
protected EntityTypeManagerInterface $entityTypeManager

Entity type manager which performs the upcasting in the end.

 from  EntityConverter
protected EntityRepositoryInterface $entityRepository

Entity repository.

 from  EntityConverter
protected LanguageManagerInterface $languageManager

The language manager.

Methods

__get($name)

Allows to access deprecated/removed properties.

from  DeprecatedServicePropertyTrait
string
getEntityTypeFromDefaults(mixed $definition, string $name, array $defaults)

Determines the entity type ID given a route definition and route defaults.

from  DynamicEntityTypeParamConverterTrait
__construct(EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository = NULL)

Constructs a new EntityConverter.

from  EntityConverter
mixed|null
convert(mixed $value, mixed $definition, string $name, array $defaults)

Converts path variables to their corresponding objects.

RevisionableInterface
getLatestTranslationAffectedRevision(RevisionableInterface $entity, string $langcode) deprecated

Returns the latest revision translation of the specified entity.

from  EntityConverter
RevisionableInterface
loadRevision(RevisionableInterface $entity, string $revision_id) deprecated

Loads the specified entity revision.

from  EntityConverter
bool
applies(mixed $definition, string $name, Route $route)

Determines if the converter applies to a specific route and variable.

LanguageManagerInterface
languageManager()

Returns a language manager instance.

from  EntityConverter
setLanguageManager(LanguageManagerInterface $language_manager)

Injects the language manager.

Details

in DeprecatedServicePropertyTrait at line 15
__get($name)

Allows to access deprecated/removed properties.

This method must be public.

Parameters

$name

in DynamicEntityTypeParamConverterTrait at line 26
protected string getEntityTypeFromDefaults(mixed $definition, string $name, array $defaults)

Determines the entity type ID given a route definition and route defaults.

Parameters

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

string

The entity type ID.

Exceptions

ParamNotConvertedException

in EntityConverter at line 106
__construct(EntityTypeManagerInterface $entity_type_manager, EntityRepositoryInterface $entity_repository = NULL)

Constructs a new EntityConverter.

Parameters

EntityTypeManagerInterface $entity_type_manager

The entity type manager.
EntityRepositoryInterface $entity_repository

The entity repository.

See also

https://www.drupal.org/node/2549139
https://www.drupal.org/node/2938929

at line 49
mixed|null convert(mixed $value, mixed $definition, string $name, array $defaults)

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.

in EntityConverter at line 170
protected RevisionableInterface getLatestTranslationAffectedRevision(RevisionableInterface $entity, string $langcode) deprecated

deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. Use \Drupal\Core\Entity\EntityRepositoryInterface::getActive() instead.

Returns the latest revision translation of the specified entity.

Parameters

RevisionableInterface $entity

The default revision of the entity being converted.
string $langcode

The language of the revision translation to be loaded.

Return Value

RevisionableInterface

The latest translation-affecting revision for the specified entity, or just the latest revision, if the specified entity is not translatable or does not have a matching translation yet.

in EntityConverter at line 201
protected RevisionableInterface loadRevision(RevisionableInterface $entity, string $revision_id) deprecated

deprecated in drupal:8.7.0 and is removed from drupal:9.0.0.

Loads the specified entity revision.

Parameters

RevisionableInterface $entity

The default revision of the entity being converted.
string $revision_id

The identifier of the revision to be loaded.

Return Value

RevisionableInterface

An entity revision object.

at line 89
bool applies(mixed $definition, string $name, Route $route)

Determines if the converter applies to a specific route and variable.

Parameters

mixed $definition

The parameter definition provided in the route options.
string $name

The name of the parameter.
Route $route

The route to consider attaching to.

Return Value

bool

TRUE if the converter applies to the passed route and parameter, FALSE otherwise.

in EntityConverter at line 238
protected LanguageManagerInterface languageManager()

internal  
 

Returns a language manager instance.

Return Value

LanguageManagerInterface

The language manager.

at line 42
setLanguageManager(LanguageManagerInterface $language_manager)

Injects the language manager.

Parameters

LanguageManagerInterface $language_manager

The language manager to get the current content language.