public static function Registrant::baseFieldDefinitions in RNG - Events and Registrations 8

Same name and namespace in other branches

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

Class

Registrant

Defines the registrant entity class.

Namespace

Drupal\rng\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = parent::baseFieldDefinitions($entity_type);
  $fields['registration'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Registration'))
    ->setDescription(t('The registration associated with this registrant.'))
    ->setSetting('target_type', 'registration')
    ->setCardinality(1)
    ->setReadOnly(TRUE);
  $fields['identity'] = BaseFieldDefinition::create('dynamic_entity_reference')
    ->setLabel(t('Identity'))
    ->setDescription(t('The person associated with this registrant.'))
    ->setSetting('exclude_entity_types', 'true')
    ->setSetting('entity_type_ids', array(
    'registrant',
    'registration',
  ))
    ->setCardinality(1)
    ->setReadOnly(TRUE);
  return $fields;
}