You are here

public static function Team::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 FieldableEdgeEntityBase::baseFieldDefinitions

See also

\Drupal\Core\Entity\EntityFieldManagerInterface::getFieldDefinitions()

\Drupal\Core\Entity\FieldableEntityInterface::bundleFieldDefinitions()

File

modules/apigee_edge_teams/src/Entity/Team.php, line 272

Class

Team
Defines the Team entity class.

Namespace

Drupal\apigee_edge_teams\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $definitions */
  $definitions = parent::baseFieldDefinitions($entity_type);
  $team_singular_label = \Drupal::entityTypeManager()
    ->getDefinition('team')
    ->getSingularLabel();
  $team_singular_label = mb_convert_case($team_singular_label, MB_CASE_TITLE);
  $definitions['displayName']
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'weight' => 0,
  ])
    ->setLabel(t("@team name", [
    '@team' => $team_singular_label,
  ]))
    ->setRequired(TRUE);
  $definitions['status']
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'status_property',
    'weight' => 2,
  ])
    ->setLabel(t('@team status', [
    '@team' => $team_singular_label,
  ]))
    ->setDisplayConfigurable('form', FALSE);
  $definitions['createdAt']
    ->setDisplayOptions('view', [
    'type' => 'timestamp_ago',
    'label' => 'inline',
    'weight' => 3,
  ])
    ->setLabel(t('Created'))
    ->setDisplayConfigurable('form', FALSE);
  $definitions['lastModifiedAt']
    ->setDisplayOptions('view', [
    'type' => 'timestamp_ago',
    'label' => 'inline',
    'weight' => 5,
  ])
    ->setLabel(t('Last updated'))
    ->setDisplayConfigurable('form', FALSE);
  $definitions['name']
    ->setLabel(t('@team id', [
    '@team' => $team_singular_label,
  ]))
    ->setDisplayConfigurable('form', FALSE)
    ->setRequired(TRUE);
  return $definitions;
}