public static function SmartDateOverride::baseFieldDefinitions in Smart Date 3.1.x

Same name and namespace in other branches

1. 8.2 modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::baseFieldDefinitions()
2. 3.x modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::baseFieldDefinitions()
3. 3.0.x modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::baseFieldDefinitions()
4. 3.2.x modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::baseFieldDefinitions()
5. 3.3.x modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::baseFieldDefinitions()
6. 3.4.x modules/smart_date_recur/src/Entity/SmartDateOverride.php \Drupal\smart_date_recur\Entity\SmartDateOverride::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

modules/smart_date_recur/src/Entity/SmartDateOverride.php, line 53

Class

SmartDateOverride

Defines the Smart Date override entity.

Namespace

Drupal\smart_date_recur\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['rrule'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('RRule ID'))
    ->setSetting('unsigned', TRUE)
    ->setRequired(TRUE);
  $fields['rrule_index'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Index of the targeted instance withing the RRule'))
    ->setSetting('unsigned', TRUE)
    ->setRequired(TRUE);
  $fields['value'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Start timestamp value'))
    ->setRequired(TRUE);
  $fields['end_value'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('End timestamp value'))
    ->setRequired(TRUE);
  $fields['duration'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Duration, in minutes'))
    ->setRequired(FALSE);

  // TODO: figure out a way to validate as required but accept zero.
  // Allow an instance to be overridden by a full entity.
  // NOTE: entity_type is skipped here because it will always match the rule.
  $fields['entity_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Entity ID'))
    ->setDescription(t('The ID of the entity which has been created as a full override.'))
    ->setRequired(FALSE);
  return $fields;
}