interface ChainEntityResolverInterface implements EntityResolverInterface (View source)

An interface for delegating a entity resolution to a chain of resolvers.

Methods

string|null
resolve(NormalizerInterface $normalizer, array $data, string $entity_type)

Returns the local ID of an entity referenced by serialized data.

addResolver(EntityResolverInterface $resolver)

Adds an entity resolver.

Details

string|null resolve(NormalizerInterface $normalizer, array $data, string $entity_type)

Returns the local ID of an entity referenced by serialized data.

Drupal entities are loaded by and internally referenced by a local ID. Because different websites can use the same local ID to refer to different entities (e.g., node "1" can be a different node on foo.com and bar.com, or on example.com and staging.example.com), it is generally unsuitable for use in hypermedia data exchanges. Instead, UUIDs, URIs, or other globally unique IDs are preferred.

This function takes a $data array representing partially deserialized data for an entity reference, and resolves it to a local entity ID. For example, depending on the data specification being used, $data might contain a 'uuid' key, a 'uri' key, a 'href' key, or some other data identifying the entity, and it is up to the implementor of this interface to resolve that appropriately for the specification being used.

Parameters

NormalizerInterface $normalizer

The Normalizer which is handling the data.

array $data

The data passed into the calling Normalizer.

string $entity_type

The type of entity being resolved; e.g., 'node' or 'user'.

Return Value

string|null

Returns the local entity ID, if found. Otherwise, returns NULL.

addResolver(EntityResolverInterface $resolver)

Adds an entity resolver.

Parameters

EntityResolverInterface $resolver

The entity resolver to add.