public static function CourseEnrollment::baseFieldDefinitions in Course 8.3

Same name and namespace in other branches

1. 8.2 src/Entity/CourseEnrollment.php \Drupal\course\Entity\CourseEnrollment::baseFieldDefinitions()
2. 3.x src/Entity/CourseEnrollment.php \Drupal\course\Entity\CourseEnrollment::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/CourseEnrollment.php, line 123

Class

CourseEnrollment

Defines the profile entity class.

Namespace

Drupal\course\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['cid'] = BaseFieldDefinition::create('entity_reference')
    ->setSetting('target_type', 'course')
    ->setRequired(TRUE)
    ->setLabel(t('Course'));
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setSetting('target_type', 'user')
    ->setRequired(TRUE)
    ->setLabel(t('User'));
  $fields['enrollmenttype'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Source'))
    ->setDescription(t('The creation source of the enrollment.'));
  $fields['status'] = BaseFieldDefinition::create('boolean')
    ->setDefaultValue(1)
    ->setLabel(t('Status'));
  $fields['timestamp'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Start'));
  $fields['enroll_end'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('End'));
  $fields['complete'] = BaseFieldDefinition::create('boolean')
    ->setLabel(t('Complete'));
  $fields['date_completed'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Date completed'));
  $fields['grade_result'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Grade result'));
  $fields['section'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Section'));
  $fields['section_name'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Section name'));
  $fields['coid'] = BaseFieldDefinition::create('entity_reference')
    ->setSetting('target_type', 'course_object')
    ->setLabel(t('Course object ID'));
  $fields['data'] = BaseFieldDefinition::create('map')
    ->setLabel(t('Data'));
  $fields['created'] = BaseFieldDefinition::create('created')
    ->setRevisionable(TRUE)
    ->setLabel('Created');
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setRevisionable(TRUE)
    ->setLabel('Changed');
  return $fields;
}