public static function CommentTestBaseField::baseFieldDefinitions in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/comment/tests/modules/comment_base_field_test/src/Entity/CommentTestBaseField.php \Drupal\comment_base_field_test\Entity\CommentTestBaseField::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/comment/tests/modules/comment_base_field_test/src/Entity/CommentTestBaseField.php, line 26

Class

CommentTestBaseField

Defines a test entity class for comment as a base field.

Namespace

Drupal\comment_base_field_test\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['test_comment'] = BaseFieldDefinition::create('comment')
    ->setLabel(t('A comment field'))
    ->setSetting('comment_type', 'test_comment_type')
    ->setDefaultValue([
    'status' => CommentItemInterface::OPEN,
  ]);
  return $fields;
}