public static function UserModuleStatus::baseFieldDefinitions in Opigno module 8

Same name and namespace in other branches

1. 3.x src/Entity/UserModuleStatus.php \Drupal\opigno_module\Entity\UserModuleStatus::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/UserModuleStatus.php, line 447

Class

UserModuleStatus

Defines the User module status entity.

Namespace

Drupal\opigno_module\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 User module status entity.'))
    ->setRevisionable(TRUE)
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setTranslatable(TRUE)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'author',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_autocomplete',
    'weight' => 5,
    'settings' => [
      'match_operator' => 'CONTAINS',
      'size' => '60',
      'autocomplete_type' => 'tags',
      'placeholder' => '',
    ],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE);
  $fields['module'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Module'))
    ->setDescription(t('The Module of this status.'))
    ->setSetting('target_type', 'opigno_module');
  $fields['score'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Score'))
    ->setDescription(t('The score the user obtained for this Module (percents)'));
  $fields['max_score'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Maximum Score'))
    ->setDescription(t('The maximum score that can be obtained for this Module.'));
  $fields['given_answers'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Given answer count'))
    ->setDescription(t('How many correct answers were given.'));
  $fields['total_questions'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Total questions count'))
    ->setDescription(t('How many answers were in the Module.'));
  $fields['percent'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Pass Percent'))
    ->setDescription('');
  $fields['last_activity'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Last activity'))
    ->setDescription(t('The last activity in a Module that has been answered.'))
    ->setSetting('target_type', 'opigno_activity');
  $fields['current_activity'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Current activity'))
    ->setDescription(t('The activity that is authorized to be answered'))
    ->setSetting('target_type', 'opigno_activity');
  $fields['evaluated'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Evaluation status'))
    ->setDescription(t('A boolean indicating whether the answer is evaluated.'))
    ->setDefaultValue(FALSE);
  $fields['started'] = BaseFieldDefinition::create('created')
    ->setLabel(t('Started'))
    ->setDescription(t('The time that the Module has started.'));
  $fields['finished'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Finished'))
    ->setDescription(t('The time that the Module finished.'));
  return $fields;
}