public static function MassContactMessage::baseFieldDefinitions in Mass Contact 8

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/MassContactMessage.php, line 123

Class

MassContactMessage: The mass contact message entity for archiving messages.

Namespace

Drupal\mass_contact\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['categories'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Categories'))
    ->setSetting('target_type', 'mass_contact_category')
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->setRequired(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'entity_reference_label',
    'weight' => -6,
  ]);
  $fields['subject'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Subject'))
    ->setRequired(TRUE)
    ->setTranslatable(FALSE)
    ->setRevisionable(FALSE)
    ->setSetting('max_length', 255)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'string',
    'weight' => -15,
  ]);
  $fields['body'] = BaseFieldDefinition::create('text_long')
    ->setLabel('body')
    ->setRequired(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'text_default',
    'weight' => 5,
  ]);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Sent by'))
    ->setDescription(t('The that sent the mass contact message.'))
    ->setSetting('target_type', 'user')
    ->setDefaultValueCallback('Drupal\\mass_contact\\Entity\\MassContactMessage::getCurrentUserId')
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'author',
    'weight' => -7,
  ]);
  $fields['sent'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Sent on'))
    ->setDescription(t('The time that the message was sent.'))
    ->setDefaultValueCallback('Drupal\\mass_contact\\Entity\\MassContactMessage::getDefaultSentTime')
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'timestamp',
    'weight' => -8,
  ]);
  return $fields;
}

You are here