public static function TokenIdentifier::baseFieldDefinitions in OAuth2 Server 8

Same name and namespace in other branches

1. 2.0.x src/Entity/TokenIdentifier.php \Drupal\oauth2_server\Entity\TokenIdentifier::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/TokenIdentifier.php, line 30

Class

TokenIdentifier

Defines the OAuth2 server JSON token identifier entity.

Namespace

Drupal\oauth2_server\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['jti_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('JTI ID'))
    ->setDescription(t('Primary key: numeric JTI id.'));
  $fields['client_id'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('OAuth2 Server Client'))
    ->setDescription(t('The OAuth2 Client of the client.'))
    ->setSettings([
    'target_type' => 'oauth2_server_client',
  ]);
  $fields['subject'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Subject'))
    ->setDescription(t('The JWT subject, usually a username or email.'))
    ->setTranslatable(FALSE)
    ->setSettings([
    'not null' => TRUE,
    'max_length' => 255,
    'text_processing' => 0,
  ]);
  $fields['jti'] = BaseFieldDefinition::create('string')
    ->setLabel(t('JTI'))
    ->setDescription(t('The JSON Token Identifier.'))
    ->setTranslatable(FALSE)
    ->setSettings([
    'not null' => TRUE,
    'max_length' => 255,
    'text_processing' => 0,
  ]);
  $fields['expires'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Expires'))
    ->setDescription(t('The Unix timestamp when the JTI expires.'));
  return $fields;
}