class LogoutController in Shibboleth Authentication 8

Class LogoutController.

@package Drupal\shib_auth\Controller

Hierarchy

• class \Drupal\Core\Controller\ControllerBase implements ContainerInjectionInterface uses LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
  • class \Drupal\shib_auth\Controller\LogoutController

File

src/Controller/LogoutController.php, line 14

Namespace

Drupal\shib_auth\Controller

class LogoutController extends ControllerBase {

  /**
   * Logout-- kills drupal then Redirects to shibboleth logout page.
   *
   * @return \Drupal\Core\Routing\TrustedRedirectResponse
   *   The redirect response.
   */
  public function logout() {

    // Logs the current user out of drupal.
    user_logout();

    // Get shibboleth config settings.
    $config = \Drupal::config('shib_auth.shibbolethsettings');

    // Get shibboleth advanced config settings.
    $adv_config = \Drupal::config('shib_auth.advancedsettings');

    // The shibboleth logout URL to redirect to.
    $logout_url = $config
      ->get('shibboleth_logout_handler_url');

    // Append the return url if it is set in the admin.
    if ($adv_config
      ->get('url_redirect_logout')) {
      $logout_url .= '?return=' . $adv_config
        ->get('url_redirect_logout');
    }

    // Redirect to the shib logout page.
    return new TrustedRedirectResponse($logout_url);
  }

  /**
   * Logout error.
   *
   * @return \Drupal\Core\Routing\TrustedRedirectResponse
   *   The redirect response.
   */
  public function logoutError() {

    // Logs the current user out of drupal.
    user_logout();

    // Get shibboleth config settings.
    $config = \Drupal::config('shib_auth.shibbolethsettings');

    // The shibboleth logout URL to redirect to with drupal error appended.
    $logout_url = $config
      ->get('shibboleth_logout_handler_url') . '?return=' . Url::fromRoute('shib_auth.logout_controller_logout_error_page')
      ->toString();

    // Redirect to the shibboleth logout page.
    return new TrustedRedirectResponse($logout_url);
  }

  /**
   * Error page for logout.
   *
   * @return array
   *   A renderable array.
   */
  public function logoutErrorPage() {

    // Get shibboleth advanced config settings.
    $adv_config = \Drupal::config('shib_auth.advancedsettings');
    return [
      '#type' => 'markup',
      '#markup' => $adv_config
        ->get('logout_error_message'),
    ];
  }

}

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::$entityManager	protected	property	The entity manager.
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	40
ControllerBase::currentUser	protected	function	Returns the current user.	1
ControllerBase::entityFormBuilder	protected	function	Retrieves the entity form builder.
ControllerBase::entityManager Deprecated	protected	function	Retrieves the entity manager service.
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. Overrides UrlGeneratorTrait::redirect
ControllerBase::state	protected	function	Returns the state storage service.
LinkGeneratorTrait::$linkGenerator	protected	property	The link generator.	1
LinkGeneratorTrait::getLinkGenerator Deprecated	protected	function	Returns the link generator.
LinkGeneratorTrait::l Deprecated	protected	function	Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated	public	function	Sets the link generator 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.
LogoutController::logout	public	function	Logout-- kills drupal then Redirects to shibboleth logout page.
LogoutController::logoutError	public	function	Logout error.
LogoutController::logoutErrorPage	public	function	Error page for logout.
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
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.
UrlGeneratorTrait::$urlGenerator	protected	property	The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated	protected	function	Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated	public	function	Sets the URL generator service.
UrlGeneratorTrait::url Deprecated	protected	function	Generates a URL or path for a specific route based on the given parameters.