public static function QuizQuestion::baseFieldDefinitions in Quiz 8.6

Same name and namespace in other branches

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

File

src/Entity/QuizQuestion.php, line 73

Class

QuizQuestion: Defines the Quiz question entity class.

Namespace

Drupal\quiz\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Title'))
    ->setRequired(TRUE)
    ->setRevisionable(TRUE)
    ->setSetting('max_length', 255)
    ->setSetting('weight', 1)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textfield',
  ]);
  $fields['body'] = BaseFieldDefinition::create('text_long')
    ->setLabel(t('Question'))
    ->setSetting('weight', 0)
    ->setRevisionable(TRUE)
    ->setRequired(TRUE)
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
  ]);
  $fields['changed'] = BaseFieldDefinition::create('changed');
  $fields['max_score'] = BaseFieldDefinition::create('integer')
    ->setRevisionable(TRUE)
    ->setLabel(t('The unscaled calculated max score of this Question.'));
  $fields['feedback'] = BaseFieldDefinition::create('text_long')
    ->setRevisionable(TRUE)
    ->setDisplayOptions('form', [
    'type' => 'text_textarea',
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setLabel(t('Generic feedback text'))
    ->setDescription(t('Will always display if configured on the Quiz.'));

  // @todo not working yet
  //    $fields['tid'] = BaseFieldDefinition::create('entity_reference_revisions')
  //      ->setSetting('target_type', 'taxonomy_term')
  //      //->setSetting('handler_settings', ['target_bundles' => ['quiz_question_term_pool' => 'quiz_question_term_pool']])
  //      ->setDisplayConfigurable('form', TRUE)
  //      ->setDisplayOptions('form', [
  //        'type' => 'entity_reference_autocomplete',
  //      ])
  //      ->setLabel('Quiz terms');
  return $fields;
}

You are here