public static function Schedule::baseFieldDefinitions in Business Rules 2.x

Same name and namespace in other branches

8 src/Entity/Schedule.php \Drupal\business_rules\Entity\Schedule::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 RevisionableContentEntityBase::baseFieldDefinitions

File

src/Entity/Schedule.php, line 324

Class

Schedule: Defines the Schedule entity.

Namespace

Drupal\business_rules\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Authored by'))
    ->setDescription(t('The user ID of author of the Schedule entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setTranslatable(FALSE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', FALSE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The unique name of the Schedule entity. Schedules with same name are replaced.'))
    ->setRevisionable(FALSE)
    ->setSettings([
    'max_length' => 50,
    'text_processing' => 0,
  ])
    ->setDisplayConfigurable('form', FALSE)
    ->setDisplayConfigurable('view', FALSE)
    ->setRequired(TRUE);
  $fields['description'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Description'))
    ->setDescription(t('The schedule description.'));
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Executed status'))
    ->setDescription(t('A boolean indicating whether the Scheduled event has been executed.'))
    ->setRevisionable(TRUE)
    ->setDefaultValue(FALSE);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Created'))
    ->setDescription(t('The time that the entity was created.'));
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t('The time that the entity was last edited.'));
  $fields['scheduled'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Scheduled date'))
    ->setDescription(t('The date and time which it is scheduled.'));
  $fields['executed'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Execution date'))
    ->setDescription(t('The date and time which was executed.'));
  $fields['triggered_by'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Action'))
    ->setDescription(t('Business Rule Action which has triggered this schedule.'))
    ->setSetting('target_type', 'business_rules_action');
  $fields['update_entity'] = BaseFieldDefinition::create('boolean')
    ->setLabel('Save entity as the last action of the task')
    ->setDescription('It the task will save the entity in the end of the process.');
  $fields['event'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Event.'))
    ->setDescription(t('The event that has created the schedule.'));
  return $fields;
}

You are here