public static function App::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()

2 calls to App::baseFieldDefinitions()

DeveloperApp::baseFieldDefinitions in src/Entity/DeveloperApp.php

Provides base field definitions for an entity type.

TeamApp::baseFieldDefinitions in modules/apigee_edge_teams/src/Entity/TeamApp.php

Provides base field definitions for an entity type.

2 methods override App::baseFieldDefinitions()

DeveloperApp::baseFieldDefinitions in src/Entity/DeveloperApp.php

Provides base field definitions for an entity type.

TeamApp::baseFieldDefinitions in modules/apigee_edge_teams/src/Entity/TeamApp.php

Provides base field definitions for an entity type.

File

src/Entity/App.php, line 280

Class

App

Base class for App Drupal entities.

Namespace

Drupal\apigee_edge\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {

  /** @var \Drupal\Core\Field\BaseFieldDefinition[] $definitions */
  $definitions = parent::baseFieldDefinitions($entity_type);
  $definitions['name']
    ->setRequired(TRUE);
  $definitions['displayName']
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'weight' => 0,
  ])
    ->setDisplayOptions('form', [
    'weight' => 0,
  ]);
  $definitions['callbackUrl'] = BaseFieldDefinition::create('app_callback_url')
    ->setDisplayOptions('form', [
    'weight' => 1,
  ])
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'weight' => 2,
  ])
    ->setDisplayConfigurable('form', TRUE)
    ->setDisplayConfigurable('view', TRUE)
    ->setLabel(t('Callback URL'));

  // Do not limit the length of the description because the API does not
  // limit that either.
  $definitions['description'] = static::getBaseFieldDefinition('description', 'string_long')
    ->setSetting('case_sensitive', TRUE)
    ->setDisplayOptions('form', [
    'weight' => 2,
  ])
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'weight' => 4,
  ]);
  $definitions['status']
    ->setDisplayOptions('view', [
    'label' => 'inline',
    'type' => 'status_property',
    'weight' => 1,
  ]);
  $definitions['createdAt']
    ->setDisplayOptions('view', [
    'type' => 'timestamp_ago',
    'label' => 'inline',
    'weight' => 3,
  ])
    ->setLabel(t('Created'));
  $definitions['lastModifiedAt']
    ->setDisplayOptions('view', [
    'type' => 'timestamp_ago',
    'label' => 'inline',
    'weight' => 5,
  ])
    ->setLabel(t('Last updated'));

  // Hide readonly properties from Manage form display list.
  $read_only_fields = [
    'appId',
    'appFamily',
    'createdAt',
    'lastModifiedAt',
    'name',
    'scopes',
    'status',
  ];
  foreach ($read_only_fields as $field) {
    $definitions[$field]
      ->setDisplayConfigurable('form', FALSE);
  }
  return $definitions;
}