You are here

function session_api_settings_form in Session API 7

Same name and namespace in other branches
  1. 5 session_api.admin.inc \session_api_settings_form()
  2. 6 session_api.admin.inc \session_api_settings_form()

Session API admin settings form.

1 string reference to 'session_api_settings_form'
session_api_menu in ./session_api.module
Implements hook_menu().

File

./session_api.admin.inc, line 11
Session API admin functions.

Code

function session_api_settings_form() {

  // Find modules that implement hook_session_api_cleanup().
  $modules = module_implements('session_api_cleanup');

  // Cookie expiry.
  $form['session_api_cookie_expire_time'] = array(
    '#type' => 'textfield',
    '#title' => t('Cookie expire time'),
    '#description' => t("The <strong>Session API</strong> module sets an additional cookie in the end users' browsers in order to " . "better track sessions across logins and logouts. This is the amount of time, in seconds, that the cookie will " . "stay valid in a user's browser. If set to 0, then the cookie will expire when the session ends (i.e, when the " . "browser closes)"),
    '#default_value' => variable_get('session_api_cookie_expire_time', 2592000),
  );

  // Cookie purging.
  $form['session_api_cookie_purge_time'] = array(
    '#type' => 'textfield',
    '#title' => t('Cookie purge time'),
    '#description' => t("Cookies will be purged on cron run when they have become unused for the amount of time set here. This is" . "separate from the cookie expire time, so sessions won't be purged before the corresponding cookie expires."),
    '#default_value' => variable_get('session_api_cookie_purge_time', 2592000),
  );

  // Cookie name.
  $description = t('This name will be used for the cookie key used by this module. Certain names for cookies might be incompatible with caching systems such as Varnish.');
  $description .= ' ' . t('<strong>Warning</strong>: Changing the cookie name will invalidate all current Session API sessions. A new cookie could also conflict with another module\'s cookie name.');
  $form['session_api_cookie_name'] = array(
    '#type' => 'textfield',
    '#title' => t('Cookie name'),
    '#default_value' => session_api_get_cookie_name(),
    '#description' => $description,
  );
  return system_settings_form($form);
}