public static function RuleSchedule::baseFieldDefinitions in RNG - Events and Registrations 8

Same name and namespace in other branches

1. 8.2 src/Entity/RuleSchedule.php \Drupal\rng\Entity\RuleSchedule::baseFieldDefinitions()
2. 3.x src/Entity/RuleSchedule.php \Drupal\rng\Entity\RuleSchedule::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/RuleSchedule.php, line 84

Class

RuleSchedule

Defines the rule scheduler entity.

Namespace

Drupal\rng\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Rule Schedule ID'))
    ->setDescription(t('The rule schedule ID.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);

  // @todo: add unique constraint.
  $fields['component'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Rule Component ID'))
    ->setDescription(t('The owner rule component ID.'))
    ->setReadOnly(TRUE)
    ->setRequired(TRUE)
    ->setSetting('target_type', 'rng_rule_component');
  $fields['trigger_date'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Execution date'))
    ->setDescription(t('The date the schedule should be added to the queue.'));
  $fields['in_queue'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('In queue'))
    ->setDescription(t('Whether to this schedule entry has been added to the queue.'))
    ->setDefaultValue(0)
    ->setRequired(TRUE);
  $fields['attempts'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Attempt count'))
    ->setDescription(t('Number of times this scheduled rule has run.'))
    ->setDefaultValue(0)
    ->setRequired(TRUE);
  return $fields;
}