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

Same name and namespace in other branches

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

Class

LPModuleAvailability

The Learning Path Module Availability entity type definition.

Namespace

Drupal\opigno_learning_path\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['id']
    ->setLabel(t('Module availability ID'))
    ->setDescription(t('The LP module availability ID.'));
  $fields['group_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel('Group ID')
    ->setDescription('The group ID')
    ->setSetting('target_type', 'group')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'learning_path' => 'learning_path',
    ],
  ]);
  $fields['entity_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel('Entity ID')
    ->setDescription('The entity ID')
    ->setSettings([
    'target_type' => 'opigno_module',
    'handler' => 'default',
  ]);
  $options = [
    0 => t('Always available'),
    1 => t('Restrict to specific dates for that training'),
  ];
  $fields['availability'] = BaseFieldDefinition::create('list_string')
    ->setLabel(t('Module availability'))
    ->setDescription(t('Set module availability for particular training.'))
    ->setSetting('allowed_values', $options)
    ->setDefaultValue(0);
  $fields['open_date'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Open date'))
    ->setDescription(t('The date this Module will become available.'));
  $fields['close_date'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Open date'))
    ->setDescription(t('The date this Module will become unavailable.'));
  return $fields;
}