public static function JobSchedule::baseFieldDefinitions in Job Scheduler 8.3

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/JobSchedule.php, line 272

Class

JobSchedule

Defines the job schedule entity.

Namespace

Drupal\job_scheduler\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['jid'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the job schedule.'))
    ->setReadOnly(TRUE)
    ->setSetting('unsigned', TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the job schedule.'))
    ->setReadOnly(TRUE);
  $fields['name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Name'))
    ->setDescription(t('The name of the job.'))
    ->setRequired(TRUE)
    ->setSetting('max_length', 128);
  $fields['type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Type'))
    ->setDescription(t('The type of the job.'))
    ->setRequired(TRUE)
    ->setSetting('max_length', 128);
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Job ID'))
    ->setDescription(t('The ID of the job.'))
    ->setRequired(TRUE);
  $fields['period'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Period'))
    ->setDescription(t('Time period after which job is to be executed.'))
    ->setDefaultValue(0);
  $fields['crontab'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Crontab'))
    ->setDescription(t('Crontab line in *NIX format.'));
  $fields['data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Data'))
    ->setDescription(t('The arbitrary data for the job.'));
  $fields['periodic'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Periodic'))
    ->setDescription(t('If true job will be automatically rescheduled.'))
    ->setDefaultValue(FALSE);
  $fields['last'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Last execution'))
    ->setDescription(t('Timestamp when a job was last executed.'));
  $fields['next'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Next execution'))
    ->setDescription(t('Timestamp when a job is to be executed.'));
  $fields['scheduled'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Scheduled'))
    ->setDescription(t('Timestamp when a job was scheduled.'))
    ->setDefaultValue(0);
  return $fields;
}