FieldResolver

Creates a FieldResolver instance.

Validates and resolves an include path into its internal possibilities.

Each resource type may define its own external names for its internal field names. As a result, a single external include path may target multiple internal paths.

This can happen when an entity reference field has different allowed entity types per bundle (as is possible with comment entities) or when different resource types share an external field name but resolve to different internal fields names.

Example 1: An installation may have three comment types for three different entity types, two of which have a file field and one of which does not. In that case, a path like @code field_comments.entity_id.media @endcode might be resolved to both @code field_comments.entity_id.field_audio @endcode and @code field_comments.entity_id.field_image @endcode.

Example 2: A path of @code field_author_profile.account @endcode might resolve to @code field_author_profile.uid @endcode and @code field_author_profile.field_user @endcode if @code field_author_profile @endcode can relate to two different JSON:API resource types (like node--profile and node--migrated_profile) which have the external field name @code account @endcode aliased to different internal field names.

Resolves external field expressions into entity query compatible paths.

It is often required to reference data which may exist across a relationship. For example, you may want to sort a list of articles by a field on the article author's representative entity. Or you may wish to filter a list of content by the name of referenced taxonomy terms.

In an effort to simplify the referenced paths and align them with the structure of JSON:API responses and the structure of the hypothetical "reference document" (see link), it is possible to alias field names and elide the "entity" keyword from them (this word is used by the entity query system to traverse entity references).

This method takes this external field expression and attempts to resolve any aliases and/or abbreviations into a field expression that will be compatible with the entity query system.

Expands the internal path with the "entity" keyword.

Get all item definitions from a set of resources types by a field name.

Resolves the UUID field name for a resource type.

Resolves the internal field name based on a collection of resource types.

Determines if the given field or member name is filterable.

Get the referenceable ResourceTypes for a set of field definitions.

Whether the given resources can be traversed to other resources.

This class shouldn't be aware of entity types and their definitions. Whether a resource can have relationships to other resources is information we ought to be able to discover on the ResourceType. However, we cannot reliably determine this information with existing APIs. Entities may be backed by various storages that are unable to perform queries across references and certain storages may not be able to store references at all.

Gets all unique reference property names from the given field definitions.

Determines the reference property name for the remaining unresolved parts.

Determines if a path part targets a specific field delta.

Determines if a path part targets a field property, not a subsequent field.

Determines if a path part targets a reference property.

Gets the property name from an entity typed or untyped path part.

A path part may contain an entity type specifier like entity:node. This extracts the actual property name. If an entity type is not specified, then the path part is simply returned. For example, both foo and foo:bar will return foo.

Gets the field access result for the 'view' operation.