public static function EncryptedFieldValue::baseFieldDefinitions in Field Encryption 8.2

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

File

src/Entity/EncryptedFieldValue.php, line 36

Class

EncryptedFieldValue: Defines the EncryptedFieldValue entity.

Namespace

Drupal\field_encrypt\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['entity_type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Entity type'))
    ->setDescription(t('The entity type for which to store the encrypted value.'))
    ->setSetting('is_ascii', TRUE)
    ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);
  $fields['entity_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Entity ID'))
    ->setDescription(t('The ID of the entity for which to store the encrypted value.'))
    ->setRequired(TRUE);
  $fields['entity_revision_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Revision ID'))
    ->setDescription(t('The revision ID of the entity.'))
    ->setSetting('unsigned', TRUE);
  $fields['field_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Field name'))
    ->setDescription(t('The field name for which to store the encrypted value.'))
    ->setSetting('is_ascii', TRUE)
    ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH);
  $fields['field_delta'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Field delta'))
    ->setDescription(t('The field delta.'))
    ->setSetting('unsigned', TRUE);
  $fields['field_property'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Field property'))
    ->setDescription(t('The field property for which to store the encrypted value.'))
    ->setSetting('is_ascii', TRUE)
    ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH);
  $fields['encrypted_value'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Encrypted value'))
    ->setDescription(t('The encrypted value'))
    ->setTranslatable(TRUE);
  return $fields;
}

You are here