You are here

public static function TeamMemberRole::baseFieldDefinitions in Apigee Edge 8

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

modules/apigee_edge_teams/src/Entity/TeamMemberRole.php, line 62

Class

TeamMemberRole
Defines the team member role entity.

Namespace

Drupal\apigee_edge_teams\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields = [];

  // We would like to use uuid as primary id to these entities and we do
  // not need anything else than the parent class could provide, so we
  // did not call it here.
  $fields[$entity_type
    ->getKey('id')] = BaseFieldDefinition::create('uuid')
    ->setLabel(t('UUID'))
    ->setReadOnly(TRUE);

  // Of a developer can change outside of Drupal and it seems the CPS
  // migration can change its developer UUID as well. This is the reason
  // why we can not use a developer entity reference here.
  $fields['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User'))
    ->setDescription(t('The Drupal user of the developer.'))
    ->setSetting('target_type', 'user')
    ->setSetting('handler', 'default')
    ->setRequired(TRUE)
    ->setDisplayConfigurable('view', FALSE)
    ->setDisplayConfigurable('form', FALSE);
  $fields['team'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Team'))
    ->setDescription(t('A team that the developer belongs.'))
    ->setSetting('target_type', 'team')
    ->setSetting('handler', 'default')
    ->setRequired(TRUE)
    ->setDisplayConfigurable('view', FALSE)
    ->setDisplayConfigurable('form', FALSE);
  $fields['roles'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Roles'))
    ->setDescription(t('The team roles of the developer within the team, except member, because that is an implied role.'))
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)
    ->setSetting('target_type', 'team_role')
    ->setSetting('handler', 'default')
    ->setRequired(TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setDisplayConfigurable('form', TRUE);
  $fields['changed'] = BaseFieldDefinition::create('changed')
    ->setLabel(t('Changed'))
    ->setDescription(t("The time that team member's roles were last edited."))
    ->setTranslatable(TRUE);
  return $fields;
}