public static function Email::baseFieldDefinitions in Courier 2.x

Same name and namespace in other branches

1. 8 src/Entity/Email.php \Drupal\courier\Entity\Email::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/Email.php, line 198

Class

Email

Defines storage for a composed email.

Namespace

Drupal\courier\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Email ID'))
    ->setDescription(t('The email ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['mail'] = BaseFieldDefinition::create('email')
    ->setLabel(t('Email'))
    ->setDescription(t('The email address to send this mail.'))
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'hidden',
  ]);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Recipient name'))
    ->setDescription(t('Nickname for the recipient.'));
  $fields['subject'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Subject'))
    ->setDescription(t('The email subject.'))
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'text_textfield',
    'weight' => 0,
  ]);
  $fields['body'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Body'))
    ->setDescription(t('The main content of the email.'))
    ->setDefaultValue('')
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
    'weight' => 50,
  ]);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language code'))
    ->setDescription(t('The email language code.'));
  return $fields;
}