class AutologoutController in Automated Logout 8

Returns responses for autologout module routes.

View source

class AutologoutController extends ControllerBase {

  /**
   * The autologout manager service.
   *
   * @var \Drupal\autologout\AutologoutManagerInterface
   */
  protected $autoLogoutManager;

  /**
   * The Time Service.
   *
   * @var \Drupal\Component\Datetime\TimeInterface
   */
  protected $time;

  /**
   * Constructs an AutologoutSubscriber object.
   *
   * @param \Drupal\autologout\AutologoutManagerInterface $autologout
   *   The autologout manager service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   */
  public function __construct(AutologoutManagerInterface $autologout, TimeInterface $time) {
    $this->autoLogoutManager = $autologout;
    $this->time = $time;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('autologout.manager'), $container
      ->get('datetime.time'));
  }

  /**
   * Alternative logout.
   */
  public function altLogout() {
    $this->autoLogoutManager
      ->logout();
    $redirect_url = $this
      ->config('autologout.settings')
      ->get('redirect_url');
    $url = Url::fromUserInput($redirect_url, [
      'absolute' => TRUE,
      'query' => [
        'autologout_timeout' => 1,
      ],
    ]);
    return new RedirectResponse($url
      ->toString());
  }

  /**
   * AJAX logout.
   */
  public function ajaxLogout() {
    $this->autoLogoutManager
      ->logout();
    $response = new AjaxResponse();
    $response
      ->setStatusCode(200);
    return $response;
  }

  /**
   * Ajax callback to reset the last access session variable.
   */
  public function ajaxSetLast() {
    $_SESSION['autologout_last'] = $this->time
      ->getRequestTime();

    // Reset the timer.
    $response = new AjaxResponse();
    $markup = $this->autoLogoutManager
      ->createTimer();
    $response
      ->addCommand(new ReplaceCommand('#timer', $markup));
    return $response;
  }

  /**
   * AJAX callback that returns the time remaining for this user is logged out.
   */
  public function ajaxGetRemainingTime() {
    $req = \Drupal::requestStack()
      ->getCurrentRequest();
    $active = $req
      ->get('uactive');
    $response = new AjaxResponse();
    if (isset($active) && $active === "false") {
      $response
        ->addCommand(new ReplaceCommand('#timer', 0));
      $response
        ->addCommand(new SettingsCommand([
        'time' => 0,
      ]));
      return $response;
    }
    $time_remaining_ms = $this->autoLogoutManager
      ->getRemainingTime() * 1000;

    // Reset the timer.
    $markup = $this->autoLogoutManager
      ->createTimer();
    $response
      ->addCommand(new ReplaceCommand('#timer', $markup));
    $response
      ->addCommand(new SettingsCommand([
      'time' => $time_remaining_ms,
    ]));
    return $response;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AutologoutController::$autoLogoutManager	protected	property	The autologout manager service.
AutologoutController::$time	protected	property	The Time Service.
AutologoutController::ajaxGetRemainingTime	public	function	AJAX callback that returns the time remaining for this user is logged out.
AutologoutController::ajaxLogout	public	function	AJAX logout.
AutologoutController::ajaxSetLast	public	function	Ajax callback to reset the last access session variable.
AutologoutController::altLogout	public	function	Alternative logout.
AutologoutController::create	public static	function	Instantiates a new instance of this class. Overrides ControllerBase::create
AutologoutController::__construct	public	function	Constructs an AutologoutSubscriber object.
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::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.
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.

You are here

class AutologoutController in Automated Logout 8

Hierarchy

File

Namespace

Members

API Navigation