public static function CourseObject::baseFieldDefinitions in Course 3.x

Same name and namespace in other branches

1. 8.3 src/Entity/CourseObject.php \Drupal\course\Entity\CourseObject::baseFieldDefinitions()
2. 8.2 src/Entity/CourseObject.php \Drupal\course\Entity\CourseObject::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/CourseObject.php, line 957

Class

CourseObject

Parent abstract base class of all course objects.

Namespace

Drupal\course\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields += static::revisionLogBaseFieldDefinitions($entity_type);
  $fields['cid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Course'));
  $fields['object_type'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Object'));
  $fields['title'] = BaseFieldDefinition::create('string')
    ->setDisplayConfigurable('view', TRUE)
    ->setRevisionable(TRUE)
    ->setLabel(t('Object title'));
  $fields['enabled'] = BaseFieldDefinition::create('boolean')
    ->setRevisionable(TRUE)
    ->setLabel(t('Course ID'));
  $fields['instance'] = BaseFieldDefinition::create('string')
    ->setRevisionable(TRUE)
    ->setLabel(t('Instance identifier'))
    ->setDescription('An ID used to identify a remote activity.');
  $fields['required'] = BaseFieldDefinition::create('boolean')
    ->setRevisionable(TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setLabel(t('Required'));
  $fields['weight'] = BaseFieldDefinition::create('integer')
    ->setRevisionable(TRUE)
    ->setLabel(t('Weight'));
  $fields['hidden'] = BaseFieldDefinition::create('boolean')
    ->setRevisionable(TRUE)
    ->setLabel(t('Hidden'));
  $fields['duration'] = BaseFieldDefinition::create('integer')
    ->setRevisionable(TRUE)
    ->setLabel(t('Duration'));
  $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;
}