public static function LPStatus::baseFieldDefinitions in Opigno Learning path 3.x

Same name and namespace in other branches

1. 8 src/Entity/LPStatus.php \Drupal\opigno_learning_path\Entity\LPStatus::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/LPStatus.php, line 551

Class

LPStatus

Defines the User Learning Path attempt status entity.

Namespace

Drupal\opigno_learning_path\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('ID'))
    ->setDescription(t('The ID of the Term entity.'))
    ->setReadOnly(TRUE);
  $fields['uuid'] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setDescription(t('The UUID of the training status.'))
    ->setReadOnly(TRUE);
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User'))
    ->setDescription(t('The user ID of the LP Status entity.'))
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default');
  $fields['gid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Training'))
    ->setDescription(t('The Training of the LP Status entity.'))
    ->setSettings([
    'target_type' => 'group',
    'default_value' => 0,
  ]);
  $fields['score'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Score'))
    ->setDescription(t('The score the user obtained for the training.'));
  $fields['status'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Status'))
    ->setDescription(t('The training status - passed/failed.'))
    ->setSettings([
    'max_length' => 15,
  ])
    ->setDefaultValue('');
  $fields['started'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Started'))
    ->setDescription(t('The time that the training has started.'))
    ->setDefaultValue(0);
  $fields['finished'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Finished'))
    ->setDescription(t('The time that the training finished.'))
    ->setDefaultValue(0);
  return $fields;
}