public static function PhoneNumberVerification::baseFieldDefinitions in SMS Framework 2.x

Same name and namespace in other branches

1. 8 src/Entity/PhoneNumberVerification.php \Drupal\sms\Entity\PhoneNumberVerification::baseFieldDefinitions()
2. 2.1.x src/Entity/PhoneNumberVerification.php \Drupal\sms\Entity\PhoneNumberVerification::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

src/Entity/PhoneNumberVerification.php, line 113

Class

PhoneNumberVerification

Defines the phone number verification entity.

Namespace

Drupal\sms\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Phone verification ID'))
    ->setDescription(t('The phone verification ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['entity'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Entity'))
    ->setDescription(t('The entity for this verification code.'))
    ->setRequired(TRUE)
    ->setReadOnly(TRUE);

  // Bundle field is required for statistics and bulk cleanup.
  $fields['bundle'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Bundle'))
    ->setDescription(t('The bundle of the entity.'))
    ->setRequired(TRUE)
    ->setReadOnly(TRUE);
  $fields['phone'] = BaseFieldDefinition::create('telephone')
    ->setLabel(t('Phone'))
    ->setDescription(t('Phone number.'))
    ->setDefaultValue('')
    ->setCardinality(1)
    ->setDisplayOptions('form', [
    'type' => 'hidden',
  ]);
  $fields['code'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Verification code'))
    ->setDescription(t('The generated verification code.'))
    ->setRequired(TRUE)
    ->setDefaultValue('');
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created on'))
    ->setDescription(t('The time that the verification code was created.'));
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Status'))
    ->setDescription(t('Verification status. 0=not verified, 1=verified.'))
    ->setDefaultValue(FALSE)
    ->setRequired(TRUE);
  return $fields;
}