public static function Quiz::baseFieldDefinitions in Quiz 8.6

Same name and namespace in other branches

1. 8.5 src/Entity/Quiz.php \Drupal\quiz\Entity\Quiz::baseFieldDefinitions()
2. 6.x src/Entity/Quiz.php \Drupal\quiz\Entity\Quiz::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 EditorialContentEntityBase::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

src/Entity/Quiz.php, line 92

Class

Quiz

Defines the Quiz entity class.

Namespace

Drupal\quiz\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::ownerBaseFieldDefinitions($entity_type);
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Title'))
    ->setDescription(t('This is only visible to Quiz admnistrators.'))
    ->setRequired(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setSetting('max_length', 255)
    ->setDisplayOptions('view', [
    'label' => 'hidden',
    'type' => 'string',
    'weight' => -5,
  ])
    ->setDisplayOptions('form', [
    'type' => 'string_textfield',
    'weight' => -5,
  ]);
  $fields['body'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Description'))
    ->setSetting('weight', 0)
    ->setRequired(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
  ]);
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setRevisionable(TRUE)
    ->setLabel('Created');
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setRevisionable(TRUE)
    ->setLabel('Changed');
  $fields['number_of_random_questions'] = BaseFieldDefinition::create('integer')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setRevisionable(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'number',
  ])
    ->setLabel(t('Number of random questions'));
  $fields['max_score_for_random'] = BaseFieldDefinition::create('integer')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'number',
  ])
    ->setLabel(t('Max score for random'));
  $fields['pass_rate'] = BaseFieldDefinition::create('integer')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'number',
  ])
    ->setSettings([
    'min' => 0,
    'max' => 100,
  ])
    ->setDescription('Passing rate for this Quiz as a percentage score.')
    ->setLabel(t('Passing rate for Quiz (%)'));
  $fields['summary_pass'] = BaseFieldDefinition::create('text_long')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
  ])
    ->setDescription('Summary text for when the user passes the Quiz. Leave blank to not give summary text if passed, or if not using the "passing rate" field above. If not using the "passing rate" field above, this text will not be used.')
    ->setLabel(t('Result text for a passing grade.'));
  $fields['summary_default'] = BaseFieldDefinition::create('text_long')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
  ])
    ->setDescription('Summary text for when the user fails the Quiz. Leave blank to not give summary text if failed, or if not using the "passing rate" field above. If not using the "passing rate" field above, this text will not be used.')
    ->setLabel(t('Result text for any grade.'));
  $fields['randomization'] = BaseFieldDefinition::create('list_integer')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
  ])
    ->setCardinality(1)
    ->setSetting('allowed_values', [
    0 => 'No randomization',
    1 => 'Random order',
    2 => 'Random questions',
    3 => 'Categorized random questions',
  ])
    ->setDescription("<strong>Random order</strong> - all questions display in random order<br>\n<strong>Random questions</strong> - specific number of questions are drawn randomly from this Quiz's pool of questions<br>\n<strong>Categorized random questions</strong> - specific number of questions are drawn from each specified taxonomy term")
    ->setDefaultValue(0)
    ->setRequired(TRUE)
    ->setLabel(t('Randomize questions'));
  $fields['backwards_navigation'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to go back and revisit questions already answered.')
    ->setLabel(t('Backwards navigation'));
  $fields['keep_results'] = BaseFieldDefinition::create('list_integer')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setCardinality(1)
    ->setDefaultValue(2)
    ->setRequired(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
  ])
    ->setSetting('allowed_values', [
    0 => 'The best',
    1 => 'The newest',
    2 => 'All',
  ])
    ->setLabel(t('Store results'))
    ->setDescription('These results should be stored for each user.');
  $fields['repeat_until_correct'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Require the user to retry the question until answered correctly.')
    ->setLabel(t('Repeat until correct'));
  $fields['quiz_date'] = BaseFieldDefinition::create('daterange')
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'daterange_default',
  ])
    ->setDescription('The date and time during which this Quiz will be available. Leave blank to always be available.')
    ->setLabel(t('Quiz date'));
  $fields['takes'] = BaseFieldDefinition::create('integer')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'number',
  ])
    ->setLabel(t('Allowed number of attempts'))
    ->setDescription('The number of times a user is allowed to take this Quiz. Anonymous users are only allowed to take Quiz that allow an unlimited number of attempts.');
  $fields['show_attempt_stats'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setSetting('min', 0)
    ->setDescription('Display the allowed number of attempts on the starting page for this Quiz.')
    ->setLabel(t('Display allowed number of attempts'));
  $fields['time_limit'] = BaseFieldDefinition::create('integer')
    ->setDisplayConfigurable('view', TRUE)
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'number',
  ])
    ->setSetting('min', 0)
    ->setDescription('Set the maximum allowed time in seconds for this Quiz. Use 0 for no limit.')
    ->setLabel(t('Time limit'));
  $fields['max_score'] = BaseFieldDefinition::create('integer')
    ->setRevisionable(TRUE)
    ->setLabel(t('Calculated max score of this quiz.'));
  $fields['allow_skipping'] = BaseFieldDefinition::create('boolean')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to skip questions in this Quiz.')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setLabel(t('Allow skipping'));
  $fields['allow_resume'] = BaseFieldDefinition::create('boolean')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to leave this Quiz incomplete and then resume it from where they left off.')
    ->setLabel(t('Allow resume'));
  $fields['allow_jumping'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to jump to any question using a menu or pager in this Quiz.')
    ->setLabel(t('Allow jumping'));
  $fields['allow_change'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('If the user is able to visit a previous question, allow them to change the answer.')
    ->setLabel(t('Allow changing answers'));
  $fields['allow_change_blank'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to go back and revisit questions already answered.')
    ->setLabel(t('Allow changing blank answers'));
  $fields['build_on_last'] = BaseFieldDefinition::create('list_string')
    ->setLabel('Each attempt builds on the last')
    ->setDisplayConfigurable('form', TRUE)
    ->setDefaultValue('fresh')
    ->setRequired(TRUE)
    ->setCardinality(1)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'options_buttons',
  ])
    ->setSetting('allowed_values', [
    'fresh' => t('Fresh attempt every time'),
    'correct' => t('Prepopulate with correct answers from last result'),
    'all' => t('Prepopulate with all answers from last result'),
  ])
    ->setDescription('Instead of starting a fresh Quiz, users can base a new attempt on the last attempt, with correct answers prefilled. Set the default selection users will see. Selecting "fresh attempt every time" will not allow the user to choose.');
  $fields['show_passed'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Show a message if the user has previously passed the Quiz.')
    ->setLabel(t('Show passed message'));
  $fields['mark_doubtful'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValueCallback('\\Drupal\\quiz\\Util\\QuizUtil::baseFieldDefault')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'boolean_checkbox',
  ])
    ->setDescription('Allow users to mark their answers as doubtful.')
    ->setLabel(t('Mark doubtful'));
  $fields['review_options'] = BaseFieldDefinition::create('map')
    ->setRevisionable(TRUE)
    ->setLabel(t('Review options'));
  $fields['result_type'] = BaseFieldDefinition::create('entity_reference')
    ->setSetting('target_type', 'quiz_result_type')
    ->setRequired(TRUE)
    ->setDefaultValue('quiz_result')
    ->setDisplayConfigurable('form', TRUE)
    ->setRevisionable(TRUE)
    ->setLabel(t('Result type to use'));
  $fields['result_options'] = BaseFieldDefinition::create('entity_reference_revisions')
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->setSetting('target_type', 'paragraph')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'quiz_result_feedback' => 'quiz_result_feedback',
    ],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_paragraphs',
  ])
    ->setLabel('Result options');
  $fields['quiz_terms'] = BaseFieldDefinition::create('entity_reference_revisions')
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->setSetting('target_type', 'paragraph')
    ->setSetting('handler_settings', [
    'target_bundles' => [
      'quiz_question_term_pool' => 'quiz_question_term_pool',
    ],
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'entity_reference_paragraphs',
  ])
    ->setLabel('Quiz terms');
  return $fields;
}