interface ScopeEntityNameInterface in Simple OAuth (OAuth2) & OpenID Connect 5.x

Extends the scope entity to include a name and description.

Hierarchy

• interface \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\simple_oauth\Entities\ScopeEntityNameInterface extends \League\OAuth2\Server\Entities\ScopeEntityInterface

1 file declares its use of ScopeEntityNameInterface

OpenIdConnectScopeEntity.php in src/Entities/OpenIdConnectScopeEntity.php

File

src/Entities/ScopeEntityNameInterface.php, line 11

Namespace

Drupal\simple_oauth\Entities

interface ScopeEntityNameInterface extends ScopeEntityInterface, CacheableDependencyInterface {

  /**
   * Returns a name for the scope.
   *
   * @return string
   *   The name of the scope.
   */
  public function getName();

  /**
   * Returns a description for the scope.
   *
   * @return string|null
   *   The description of the scope.
   */
  public function getDescription();

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
ScopeEntityNameInterface::getDescription	public	function	Returns a description for the scope.	1
ScopeEntityNameInterface::getName	public	function	Returns a name for the scope.	1