class OpenIDConnectClientController in OpenID Connect / OAuth client 2.x

Controller for operations on the OpenID Connect clients.

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\openid_connect\Controller\OpenIDConnectClientController

File

src/Controller/OpenIDConnectClientController.php, line 12

Namespace

Drupal\openid_connect\Controller

class OpenIDConnectClientController extends ControllerBase {

  /**
   * Build the OpenID Connect client instance add form.
   *
   * @param string $plugin_id
   *   The plugin ID for the OpenID Connect client instance.
   *
   * @return array
   *   The OpenID Connect client add form.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function add(string $plugin_id) : array {

    // Create an OpenID Connect client entity.
    $entity = $this
      ->entityTypeManager()
      ->getStorage('openid_connect_client')
      ->create([
      'plugin' => $plugin_id,
    ]);
    return $this
      ->entityFormBuilder()
      ->getForm($entity, 'add');
  }

  /**
   * Enable an OpenID Connect client.
   *
   * @param \Drupal\openid_connect\OpenIDConnectClientEntityInterface $openid_connect_client
   *   The OpenID Connect client entity to enable.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect back to the client list page.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function enable(OpenIDConnectClientEntityInterface $openid_connect_client) : RedirectResponse {
    $openid_connect_client
      ->enable()
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('The %label client has been enabled.', [
      '%label' => $openid_connect_client
        ->label(),
    ]));

    // Return to the listing page.
    return $this
      ->redirect('entity.openid_connect_client.list', [], []);
  }

  /**
   * Disable an OpenID Connect client.
   *
   * @param \Drupal\openid_connect\OpenIDConnectClientEntityInterface $openid_connect_client
   *   The OpenID Connect client entity to disable.
   *
   * @return \Symfony\Component\HttpFoundation\RedirectResponse
   *   A redirect back to the client list page.
   *
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public function disable(OpenIDConnectClientEntityInterface $openid_connect_client) : RedirectResponse {
    $openid_connect_client
      ->disable()
      ->save();
    $this
      ->messenger()
      ->addMessage($this
      ->t('The %label client has been disabled.', [
      '%label' => $openid_connect_client
        ->label(),
    ]));

    // Return to the listing page.
    return $this
      ->redirect('entity.openid_connect_client.list', [], []);
  }

}

Members

Name	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.
OpenIDConnectClientController::add	public	function	Build the OpenID Connect client instance add form.
OpenIDConnectClientController::disable	public	function	Disable an OpenID Connect client.
OpenIDConnectClientController::enable	public	function	Enable an OpenID Connect client.
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.
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.