You are here

public static function EntityUpdateTestsContentEntity::baseFieldDefinitions in Entity Update 2.0.x

Same name and namespace in other branches
  1. 8 modules/entity_update_tests/src/Entity/EntityUpdateTestsContentEntity.php \Drupal\entity_update_tests\Entity\EntityUpdateTestsContentEntity::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 ContentEntityBase::baseFieldDefinitions

See also

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

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

File

tests/modules/entity_update_tests/src/Entity/EntityUpdateTestsContentEntity.php, line 49

Class

EntityUpdateTestsContentEntity
Defines the Paragraph entity.

Namespace

Drupal\entity_update_tests\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);

  // Fix field.
  $fields['fix'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Fix field.'))
    ->setSettings([
    'max_length' => 10,
    'text_processing' => 0,
  ]);

  // Dynamic name field to simulation deletation and creation.
  if (EntityUpdateTestHelper::fieldStatus('name')) {
    $fields['name'] = BaseFieldDefinition::create('string')
      ->setLabel(t('Name'))
      ->setSettings([
      'max_length' => 100,
      'text_processing' => 0,
    ]);
  }

  // Dynamic description field to simulation deletation and creation.
  if (EntityUpdateTestHelper::fieldStatus('description')) {
    $fields['description'] = BaseFieldDefinition::create('string_long')
      ->setLabel(t('Description'))
      ->setSettings([
      'text_processing' => 0,
    ]);
  }

  // Dynamic type field to simulate file type update.
  $type = EntityUpdateTestHelper::fieldStatus('type');
  $types = [
    'string',
    'integer',
  ];
  if (in_array($type, $types)) {
    $fields['type'] = BaseFieldDefinition::create($type)
      ->setLabel(t('Type'))
      ->setSettings([
      'max_length' => 10,
      'text_processing' => 0,
    ]);
  }
  return $fields;
}