public static function ConfigEntityRevisions::baseFieldDefinitions in Config Entity Revisions 1.x

Same name and namespace in other branches

1. 8.2 src/Entity/ConfigEntityRevisions.php \Drupal\config_entity_revisions\Entity\ConfigEntityRevisions::baseFieldDefinitions()
2. 8 src/Entity/ConfigEntityRevisions.php \Drupal\config_entity_revisions\Entity\ConfigEntityRevisions::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 EditorialContentEntityBase::baseFieldDefinitions

See also

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

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

File

src/Entity/ConfigEntityRevisions.php, line 70

Class

ConfigEntityRevisions

Defines the config entity revision entity class.

Namespace

Drupal\config_entity_revisions\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['configuration'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('Configuration'))
    ->setDescription(t('The serialised configuration for this revision.'))
    ->setReadOnly(TRUE)
    ->setRequired(TRUE)
    ->setTranslatable(FALSE)
    ->setRevisionable(TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the configuration entity was last edited.'))
    ->setRevisionable(TRUE)
    ->setTranslatable(TRUE);
  $fields['moderation_state'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Moderation state'))
    ->setDescription(t('The moderation state of this revision.'))
    ->setRequired(TRUE)
    ->setTranslatable(TRUE)
    ->setRevisionable(TRUE);
  return $fields;
}