You are here

class ServerScopeController in OAuth2 Server 2.0.x

Same name and namespace in other branches
  1. 8 src/Controller/ServerScopeController.php \Drupal\oauth2_server\Controller\ServerScopeController

Class Server Scope Controller.

@package Drupal\oauth2_server\Controller

Hierarchy

Expanded class hierarchy of ServerScopeController

File

src/Controller/ServerScopeController.php, line 14

Namespace

Drupal\oauth2_server\Controller
View source
class ServerScopeController extends ControllerBase {

  /**
   * Return a list of scopes for a OAuth2 server.
   *
   * @param \Drupal\oauth2_server\ServerInterface $oauth2_server
   *   The server to display the scopes of.
   *
   * @return array
   *   The renderable array.
   */
  public function serverScopes(ServerInterface $oauth2_server) {
    return $this
      ->entityTypeManager()
      ->getListBuilder('oauth2_server_scope')
      ->render($oauth2_server);
  }

  /**
   * Returns the page title for an server's "Scopes" tab.
   *
   * @param \Drupal\oauth2_server\ServerInterface $oauth2_server
   *   The server that is displayed.
   *
   * @return string
   *   The page title.
   */
  public function serverScopesTitle(ServerInterface $oauth2_server) {
    return $this
      ->t('OAuth2 Server: %name scopes', [
      '%name' => $oauth2_server
        ->label(),
    ]);
  }

  /**
   * Returns the form for adding a scope to a server.
   *
   * @param \Drupal\oauth2_server\ServerInterface $oauth2_server
   *   The server the scope should belong to.
   *
   * @return array
   *   The renderable form array.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function serverAddScope(ServerInterface $oauth2_server) {
    $scope = $this
      ->entityTypeManager()
      ->getStorage('oauth2_server_scope')
      ->create([
      'server_id' => $oauth2_server
        ->id(),
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($scope, 'add', [
      'oauth2_server' => $oauth2_server,
    ]);
  }

  /**
   * Returns the form for editing a scope to a server.
   *
   * @param \Drupal\oauth2_server\ServerInterface $oauth2_server
   *   The server the scope should belong to.
   * @param \Drupal\oauth2_server\ScopeInterface $oauth2_server_scope
   *   The scope entity.
   *
   * @return array
   *   The renderable form.
   */
  public function serverEditScope(ServerInterface $oauth2_server, ScopeInterface $oauth2_server_scope) {
    return $this
      ->entityFormBuilder()
      ->getForm($oauth2_server_scope, 'edit', [
      'oauth2_server' => $oauth2_server,
    ]);
  }

  /**
   * Returns the form for deleting a scope to a server.
   *
   * @param \Drupal\oauth2_server\ServerInterface $oauth2_server
   *   The server the scope should belong to.
   * @param \Drupal\oauth2_server\ScopeInterface $oauth2_server_scope
   *   The scope entity.
   *
   * @return array
   *   The renderable form.
   */
  public function serverDeleteScope(ServerInterface $oauth2_server, ScopeInterface $oauth2_server_scope) {
    return $this
      ->entityFormBuilder()
      ->getForm($oauth2_server_scope, 'delete', [
      'oauth2_server' => $oauth2_server,
    ]);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 46
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route.
ControllerBase::state protected function Returns the state storage service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
ServerScopeController::serverAddScope public function Returns the form for adding a scope to a server.
ServerScopeController::serverDeleteScope public function Returns the form for deleting a scope to a server.
ServerScopeController::serverEditScope public function Returns the form for editing a scope to a server.
ServerScopeController::serverScopes public function Return a list of scopes for a OAuth2 server.
ServerScopeController::serverScopesTitle public function Returns the page title for an server's "Scopes" tab.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.