1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Entity
  7. \
  8. EntityFieldManagerInterface

EntityFieldManagerInterface

interface EntityFieldManagerInterface (View source)

Provides an interface for an entity field manager.

Methods

FieldDefinitionInterface[]
getBaseFieldDefinitions(string $entity_type_id)

Gets the base field definitions for a content entity type.

FieldDefinitionInterface[]
getFieldDefinitions(string $entity_type_id, string $bundle)

Gets the field definitions for a specific bundle.

FieldStorageDefinitionInterface[]
getFieldStorageDefinitions(string $entity_type_id)

Gets the field storage definitions for a content entity type.

array
getFieldMap()

Gets a lightweight map of fields across bundles.

$this
setFieldMap(array $field_map)

Sets a lightweight map of fields across bundles.

array
getFieldMapByFieldType(string $field_type)

Gets a lightweight map of fields across bundles filtered by field type.

clearCachedFieldDefinitions()

Clears static and persistent field definition caches.

useCaches(bool $use_caches = FALSE)

Disable the use of caches.

array
getExtraFields(string $entity_type_id, string $bundle)

Gets the "extra fields" for a bundle.

Details

at line 28
FieldDefinitionInterface[] getBaseFieldDefinitions(string $entity_type_id)

Gets the base field definitions for a content entity type.

Only fields that are not specific to a given bundle or set of bundles are returned. This excludes configurable fields, as they are always attached to a specific bundle.

Parameters

string $entity_type_id

The entity type ID. Only entity types that implement \Drupal\Core\Entity\FieldableEntityInterface are supported.

Return Value

FieldDefinitionInterface[]

The array of base field definitions for the entity type, keyed by field name.

Exceptions

LogicException

at line 42
FieldDefinitionInterface[] getFieldDefinitions(string $entity_type_id, string $bundle)

Gets the field definitions for a specific bundle.

Parameters

string $entity_type_id

The entity type ID. Only entity types that implement \Drupal\Core\Entity\FieldableEntityInterface are supported.
string $bundle

The bundle.

Return Value

FieldDefinitionInterface[]

The array of field definitions for the bundle, keyed by field name.

at line 62
FieldStorageDefinitionInterface[] getFieldStorageDefinitions(string $entity_type_id)

Gets the field storage definitions for a content entity type.

This returns all field storage definitions for base fields and bundle fields of an entity type. Note that field storage definitions of a base field equal the full base field definition (i.e. they implement FieldDefinitionInterface), while the storage definitions for bundle fields may implement FieldStorageDefinitionInterface only.

Parameters

string $entity_type_id

The entity type ID. Only content entities are supported.

Return Value

FieldStorageDefinitionInterface[]

The array of field storage definitions for the entity type, keyed by field name.

See also

FieldStorageDefinitionInterface

at line 74
array getFieldMap()

Gets a lightweight map of fields across bundles.

Return Value

array

An array keyed by entity type. Each value is an array which keys are field names and value is an array with two entries:

  • type: The field type.
  • bundles: An associative array of the bundles in which the field appears, where the keys and values are both the bundle's machine name.

at line 84
$this setFieldMap(array $field_map)

Sets a lightweight map of fields across bundles.

Parameters

array $field_map

See the return value of self::getFieldMap().

Return Value

$this

at line 99
array getFieldMapByFieldType(string $field_type)

Gets a lightweight map of fields across bundles filtered by field type.

Parameters

string $field_type

The field type to filter by.

Return Value

array

An array keyed by entity type. Each value is an array which keys are field names and value is an array with two entries:

  • type: The field type.
  • bundles: An associative array of the bundles in which the field appears, where the keys and values are both the bundle's machine name.

at line 104
clearCachedFieldDefinitions()

Clears static and persistent field definition caches.

at line 112
useCaches(bool $use_caches = FALSE)

Disable the use of caches.

Parameters

bool $use_caches

FALSE to not use any caches.

at line 141
array getExtraFields(string $entity_type_id, string $bundle)

Gets the "extra fields" for a bundle.

Parameters

string $entity_type_id

The entity type ID.
string $bundle

The bundle name.

Return Value

array

A nested array of 'pseudo-field' elements. Each list is nested within the following keys: entity type, bundle name, context (either 'form' or 'display'). The keys are the name of the elements as appearing in the renderable array (either the entity form or the displayed entity). The value is an associative array:

  • label: The human readable name of the element. Make sure you sanitize this appropriately.
  • description: A short description of the element contents.
  • weight: The default weight of the element.
  • visible: (optional) The default visibility of the element. Defaults to TRUE.
  • edit: (optional) String containing markup (normally a link) used as the element's 'edit' operation in the administration interface. Only for 'form' context.
  • delete: (optional) String containing markup (normally a link) used as the element's 'delete' operation in the administration interface. Only for 'form' context.