You are here

Home » API reference » OAuth2 Server 8 » Server.php

class Server in OAuth2 Server 8

Same name and namespace in other branches
  1. 2.0.x src/Entity/Server.php \Drupal\oauth2_server\Entity\Server

Defines the OAuth2 server entity.

Plugin annotation


@ConfigEntityType(
  id = "oauth2_server",
  label = @Translation("OAuth2 Server"),
  handlers = {
    "storage" = "Drupal\Core\Config\Entity\ConfigEntityStorage",
    "view_builder" = "Drupal\Core\Entity\EntityViewBuilder",
    "list_builder" = "Drupal\oauth2_server\ServerListBuilder",
    "form" = {
      "add" = "Drupal\oauth2_server\Form\ServerForm",
      "edit" = "Drupal\oauth2_server\Form\ServerForm",
      "default" = "Drupal\oauth2_server\Form\ServerForm",
      "delete" = "Drupal\oauth2_server\Form\ServerDeleteConfirmForm",
      "disable" = "Drupal\oauth2_server\Form\ServerDisableConfirmForm"
    },
  },
  config_prefix = "server",
  admin_permission = "administer oauth2 server",
  entity_keys = {
    "id" = "server_id",
    "label" = "name",
    "uuid" = "uuid",
    "status" = "status"
  },
  links = {
    "add-form" = "/admin/structure/oauth2-servers/add-server",
    "edit-form" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/edit",
    "delete-form" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/delete",
    "disable" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/disable",
    "enable" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/enable",
    "scopes" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/scopes",
    "clients" = "/admin/structure/oauth2-servers/manage/{oauth2_server}/clients",
  },
  config_export = {
    "server_id",
    "name",
    "settings",
    "status",
    "module"
  }
)

Hierarchy

Expanded class hierarchy of Server

File

src/Entity/Server.php, line 54

Namespace

Drupal\oauth2_server\Entity
View source 
class Server extends ConfigEntityBase implements ServerInterface {

  /**
   * The machine name of this server.
   *
   * @var string
   */
  protected $server_id;

  /**
   * The human-readable name of this server.
   *
   * @var string
   */
  protected $name;

  /**
   * An array of settings.
   *
   * @var array
   */
  public $settings = [
    'default_scope' => '',
    'enforce_state' => TRUE,
    'allow_implicit' => FALSE,
    'use_openid_connect' => FALSE,
    'use_crypto_tokens' => FALSE,
    'store_encrypted_token_string' => FALSE,
    'grant_types' => [
      'authorization_code' => 'authorization_code',
      'refresh_token' => 'refresh_token',
    ],
    'advanced_settings' => [
      'access_lifetime' => 3600,
      'id_lifetime' => 3600,
      'refresh_token_lifetime' => 1209600,
      'require_exact_redirect_uri' => TRUE,
    ],
  ];

  /**
   * The name of the providing module if the server has been defined in code.
   *
   * @var string
   */
  protected $module;

  /**
   * {@inheritdoc}
   */
  public function id() {
    return isset($this->server_id) ? $this->server_id : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function label() {
    return isset($this->name) ? $this->name : NULL;
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    $old_settings = isset($this->original) ? $this->original->settings : [];
    $previous_value = !empty($old_settings['use_openid_connect']);
    $current_value = !empty($this->settings['use_openid_connect']);
    if (!$previous_value && $current_value) {
      $openid_scopes = [
        'openid' => new FormattableMarkup('Know who you are on @site', [
          '@site' => \Drupal::config('system.site')
            ->get('name'),
        ]),
        'offline_access' => "Access the API when you're not present.",
        'email' => 'View your email address.',
        'profile' => 'View basic information about your account.',
      ];
      foreach ($openid_scopes as $id => $description) {

        /** @var \Drupal\oauth2_server\ScopeInterface $scope */
        $scope = $this
          ->entityTypeManager()
          ->getStorage('oauth2_server_scope')
          ->load($this
          ->id() . '_' . $id);
        if (!$scope) {
          $scope = Scope::create([
            'scope_id' => $id,
            'server_id' => $this
              ->id(),
            'description' => $description,
          ]);
          $scope
            ->save();
        }
      }
    }

    // If OpenID Connect was just disabled, delete its scopes.
    if ($previous_value && !$current_value) {
      $scope_names = [
        'openid',
        'offline_access',
        'email',
        'profile',
      ];

      /** @var \Drupal\oauth2_server\ScopeInterface[] $scopes */
      $scopes = $this
        ->entityTypeManager()
        ->getStorage('oauth2_server_scope')
        ->loadByProperties([
        'server_id' => $this
          ->id(),
        'scope_id' => $scope_names,
      ]);
      foreach ($scopes as $scope) {
        $scope
          ->delete();
      }

      // If we just deleted a default scope, update the server.
      if (in_array($this->settings['default_scope'], $scope_names)) {
        $this->settings['default_scope'] = '';
        $this
          ->save();
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function delete() {
    parent::delete();

    // Clean up scopes.

    /** @var \Drupal\oauth2_server\ScopeInterface[] $scopes */
    $scopes = $this
      ->entityTypeManager()
      ->getStorage('oauth2_server_scope')
      ->loadByProperties([
      'server_id' => $this
        ->id(),
    ]);
    foreach ($scopes as $scope) {
      $scope
        ->delete();
    }

    // Clean up clients.

    /** @var \Drupal\oauth2_server\ClientInterface[] $clients */
    $clients = $this
      ->entityTypeManager()
      ->getStorage('oauth2_server_client')
      ->loadByProperties([
      'server_id' => $this
        ->id(),
    ]);
    foreach ($clients as $client) {
      $client
        ->delete();
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides EntityBase::preSave 13
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
Server::$module protected property The name of the providing module if the server has been defined in code.
Server::$name protected property The human-readable name of this server.
Server::$server_id protected property The machine name of this server.
Server::$settings public property An array of settings.
Server::delete public function Deletes an entity permanently. Overrides EntityBase::delete
Server::id public function Gets the identifier. Overrides EntityBase::id
Server::label public function Gets the label of the entity. Overrides EntityBase::label
Server::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function