public static function EntityTestComputedField::baseFieldDefinitions in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/system/tests/modules/entity_test/src/Entity/EntityTestComputedField.php \Drupal\entity_test\Entity\EntityTestComputedField::baseFieldDefinitions()

Provides base field definitions for an entity type.

Implementations typically use the class \Drupal\Core\Field\BaseFieldDefinition for creating the field definitions; for example a 'name' field could be defined as the following:

$fields['name'] = BaseFieldDefinition::create('string')
  ->setLabel(t('Name'));

By definition, base fields are fields that exist for every bundle. To provide definitions for fields that should only exist on some bundles, use \Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions().

The definitions returned by this function can be overridden for all bundles by hook_entity_base_field_info_alter() or overridden on a per-bundle basis via 'base_field_override' configuration entities.

Parameters

\Drupal\Core\Entity\EntityTypeInterface $entity_type: The entity type definition. Useful when a single class is used for multiple, possibly dynamic entity types.

Return value

\Drupal\Core\Field\FieldDefinitionInterface[] An array of base field definitions for the entity type, keyed by field name.

Overrides EntityTest::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

core/modules/system/tests/modules/entity_test/src/Entity/EntityTestComputedField.php, line 38

Class

EntityTestComputedField

An entity used for testing computed field values.

Namespace

Drupal\entity_test\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['computed_string_field'] = BaseFieldDefinition::create('string')
    ->setLabel('Computed Field Test')
    ->setComputed(TRUE)
    ->setClass(ComputedTestFieldItemList::class);
  $fields['computed_reference_field'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel('Computed Reference Field Test')
    ->setComputed(TRUE)
    ->setSetting('target_type', 'entity_test')
    ->setClass(ComputedReferenceTestFieldItemList::class);
  $fields['computed_test_cacheable_string_field'] = BaseFieldDefinition::create('computed_test_cacheable_string_item')
    ->setLabel(new TranslatableMarkup('Computed Cacheable String Field Test'))
    ->setComputed(TRUE)
    ->setClass(ComputedTestCacheableStringItemList::class)
    ->setReadOnly(FALSE)
    ->setInternal(FALSE);
  return $fields;
}