public static function LPResult::baseFieldDefinitions in Opigno Learning path 8

Same name and namespace in other branches

1. 3.x src/Entity/LPResult.php \Drupal\opigno_learning_path\Entity\LPResult::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/LPResult.php, line 209

Class

LPResult

Defines the Learning Path Content entity.

Namespace

Drupal\opigno_learning_path\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['learning_path_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel('Learning Path')
    ->setCardinality(1)
    ->setSetting('target_type', 'group')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'learning_path' => 'learning_path',
    ],
  ]);
  $fields['user_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel('User')
    ->setSetting('target_type', 'user');
  $fields['has_passed'] = BaseFieldDefinition::create('boolean')
    ->setLabel('Has passed')
    ->setDescription('Define if the user has passed the learning path')
    ->setDefaultValue(FALSE);
  $fields['started'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Started'))
    ->setDescription(t('The time that the LP attempt has started.'));
  $fields['finished'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Finished'))
    ->setDescription(t('The time that the LP attempt finished.'));
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Creation datetime'))
    ->setDescription(t('The time that the result was saved.'));
  return $fields;
}