public static function SiteAlert::baseFieldDefinitions in Site Alert 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/SiteAlert.php, line 143

Class

SiteAlert: Implements SiteAlert class.

Namespace

Drupal\site_alert\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the Site Alert entity.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the Site Alert entity.'))
    ->setReadOnly(TRUE);
  $fields['label'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Label'))
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => 0,
  ])
    ->setRequired(TRUE);
  $fields['active'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Active'))
    ->setDescription(t('If checked, site alert is active.'))
    ->setDefaultValue(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
    'weight' => 1,
  ]);
  $fields['severity'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Severity'))
    ->setSetting('allowed_values', self::SEVERITY_OPTIONS)
    ->setDisplayOptions('form', [
    'type' => 'options_select',
    'weight' => 2,
  ])
    ->setRequired(TRUE);
  $fields['message'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Message'))
    ->setDescription(t('This is the text of the alert that will be shown'))
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
    'weight' => 3,
  ])
    ->setRequired(TRUE);
  $fields['scheduling'] = BaseFieldDefinition::create('daterange')
    ->setLabel(t('Scheduling'))
    ->setDisplayOptions('form', [
    'type' => 'daterange_default',
    'weight' => 4,
  ]);
  return $fields;
}

You are here