autologout.api.php in Automated Logout 7.4

Describe hooks provided by the autologout module.

File

autologout.api.php

<?php

/**
 * @file
 * Describe hooks provided by the autologout module.
 */

/**
 * Prevent autologout logging a user out.
 *
 * This allows other modules to indicate that a page should not be included
 * in the autologout checks. This works in the same way as not ticking the
 * enforce on admin pages option for autologout which stops a user being logged
 * out of admin pages.
 *
 * @return bool
 *   Return TRUE if you do not want the user to be logged out.
 *   Return FALSE (or nothing) if you want to leave the autologout
 *   process alone.
 */
function hook_autologout_prevent() {

  // Don't include autologout JS checks on ajax callbacks.
  if (in_array(arg(0), array(
    'ajax',
    'autologout_ahah_logout',
    'autologout_ahah_set_last',
  ))) {
    return TRUE;
  }
}

/**
 * Keep a login alive whilst the user is on a particular page.
 *
 * @return bool
 *   By returning TRUE from this function the JS which talks to autologout
 *   module is included in the current page request and periodically dials
 *   back to the server to keep the login alive.
 *   Return FALSE (or nothing) to just use the standard behaviour.
 */
function hook_autologout_refresh_only() {

  // Check to see if an open admin page will keep
  // login alive.
  if (arg(0) == 'admin' && !variable_get('autologout_enforce_admin', FALSE)) {
    return TRUE;
  }
}

/**
 * Let others act when session is extended.
 *
 * Use case: Some applications might be embedding the some other
 * applications via iframe which also requires to extend its sessions.
 */
function hook_auto_logout_session_reset($user) {
  $myOtherIframeApplication
    ->resetSession($user->uid);
}

/**
 * Let other modules modify the timeout value.
 */
function hook_autologout_timeout_alter(&$timeout) {
  $timeout = 1800;
}

/**
 * Allow the redirect URL and query to be modified prior to auto-logout.
 *
 * Use case: For example, if certain users such as Admins need to be
 * redirected to a special admin-only URL.
 */
function hook_autologout_redirect_url_alter(&$redirect_url, &$redirect_query) {
  global $user;
  if ($user->name == 'jane.doe') {
    $redirect_url = 'bye-jane';
  }
  if ($user->name == 'mallory') {
    $redirect_query['was_mallory'] = 1;
  }
}

Functions

Name	Description
hook_autologout_prevent	Prevent autologout logging a user out.
hook_autologout_redirect_url_alter	Allow the redirect URL and query to be modified prior to auto-logout.
hook_autologout_refresh_only	Keep a login alive whilst the user is on a particular page.
hook_autologout_timeout_alter	Let other modules modify the timeout value.
hook_auto_logout_session_reset	Let others act when session is extended.