public static function Message::baseFieldDefinitions in Message 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/Message.php, line 159

Class

Message: Defines the Message entity class.

Namespace

Drupal\message\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['mid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Message ID'))
    ->setDescription(t('The message ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The message UUID'))
    ->setReadOnly(TRUE);
  $fields['template'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Template'))
    ->setDescription(t('The message template.'))
    ->setSetting('target_type', 'message_template')
    ->setReadOnly(TRUE);
  $fields['langcode'] = BaseFieldDefinition::create('language')
    ->setLabel(t('Language code'))
    ->setDescription(t('The message language code.'));
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Created by'))
    ->setDescription(t('The user that created the message.'))
    ->setSettings([
    'target_type' => 'user',
    'default_value' => 0,
  ])
    ->setDefaultValueCallback('Drupal\\message\\Entity\\Message::getCurrentUserId')
    ->setTranslatable(TRUE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created on'))
    ->setDescription(t('The time that the message was created.'))
    ->setTranslatable(TRUE);
  $fields['arguments'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Arguments'))
    ->setDescription(t('Holds the arguments of the message in serialise format.'));
  return $fields;
}

You are here