You are here

public static function TeamApp::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 App::baseFieldDefinitions

See also

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

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

File

modules/apigee_edge_teams/src/Entity/TeamApp.php, line 159

Class

TeamApp
Defines the Team (company) app 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_app_singular_label = \Drupal::entityTypeManager()
    ->getDefinition('team_app')
    ->getSingularLabel();
  $team_app_singular_label = mb_convert_case($team_app_singular_label, MB_CASE_TITLE);
  $definitions['displayName']
    ->setLabel(t('@team_app name', [
    '@team_app' => $team_app_singular_label,
  ]));
  $definitions['status']
    ->setLabel(t('@team_app status', [
    '@team_app' => $team_app_singular_label,
  ]));
  $team_app_settings = \Drupal::config('apigee_edge_teams.team_app_settings');
  foreach ((array) $team_app_settings
    ->get('required_base_fields') as $required) {
    $definitions[$required]
      ->setRequired(TRUE);
  }

  // Hide readonly properties from Manage form display list.
  $definitions['companyName']
    ->setDisplayConfigurable('form', FALSE);
  return $definitions;
}