public static function MessageQueueItem::baseFieldDefinitions in Courier 8

Same name and namespace in other branches

1. 2.x src/Entity/MessageQueueItem.php \Drupal\courier\Entity\MessageQueueItem::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/MessageQueueItem.php, line 103

Class

MessageQueueItem

Defines a Message queue item entity.

Namespace

Drupal\courier\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Message queue item ID'))
    ->setDescription(t('Message queue item ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Date of creation'))
    ->setDescription(t('The date the queue item was created.'))
    ->setRequired(TRUE);
  $fields['identity'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Identity'))
    ->setDescription(t('Identity to send the message.'))
    ->setCardinality(1)
    ->setReadOnly(TRUE);
  $fields['messages'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Messages'))
    ->setDescription(t('Messages for this this queue item.'))
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->setReadOnly(TRUE);
  $fields['options'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Options'))
    ->setDescription(t('Options to pass to channels when sending.'))
    ->setRequired(TRUE);
  return $fields;
}