public static function AuthorizationCode::baseFieldDefinitions in OAuth2 Server 8

Same name and namespace in other branches

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

Class

AuthorizationCode

Defines the OAuth2 server authorization code entity.

Namespace

Drupal\oauth2_server\Entity

Code

public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
  $fields['code_id'] = BaseFieldDefinition::create('integer')
    ->setLabel(t('Code ID'))
    ->setDescription(t('Primary key: numeric code 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['uid'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('User'))
    ->setDescription(t('The user of the resource owner.'))
    ->setSettings([
    'target_type' => 'user',
  ]);
  $fields['code'] = BaseFieldDefinition::create('string')
    ->setLabel(t('Code'))
    ->setDescription(t('The authorization code.'))
    ->setTranslatable(FALSE)
    ->setSettings([
    'not null' => TRUE,
    'max_length' => 255,
    'text_processing' => 0,
  ]);
  $fields['scopes'] = BaseFieldDefinition::create('entity_reference')
    ->setLabel(t('Scopes'))
    ->setDescription(t('The scopes of the authorization code.'))
    ->setSettings([
    'target_type' => 'oauth2_server_scope',
  ])
    ->setCardinality(FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED);
  $fields['redirect_uri'] = BaseFieldDefinition::create('uri')
    ->setLabel(t('Redirect Uri'))
    ->setDescription(t('The absolute URI to redirect to after authorization.'));
  $fields['expires'] = BaseFieldDefinition::create('timestamp')
    ->setLabel(t('Expires'))
    ->setDescription(t('The Unix timestamp when the token expires.'));
  $fields['id_token'] = BaseFieldDefinition::create('string_long')
    ->setLabel(t('ID Token'))
    ->setDescription(t('The id token, if OpenID Connect was used.'))
    ->setTranslatable(FALSE)
    ->setSettings([
    'text_processing' => 0,
    'case_sensitive' => FALSE,
  ]);
  return $fields;
}