Docs for page Session.php

## /Session.php

Description

Session handling class and associated functions

This subpackage provides some functions that are useful around web application session management.

The class is intended to be as lightweight as possible while holding all session data in the database:

- Session hash is not predictable.
- No clear text information is held in cookies.
- Passwords are generally salted MD5 hashes, but individual users may have plain text passwords set by an administrator.
- Temporary passwords are supported.
- Logout is supported
- "Remember me" cookies are supported, and will result in a new Session for each browser session.

- author: Andrew McMillan <andrew@mcmillan.net.nz>
- copyright: Catalyst IT Ltd, Morphoss Ltd <http://www.morphoss.com/>
- license: GNU GPL v2 or later

Classes

Class | Description
--- | ---
Session | A class for creating and holding session information.

Includes
require_once ('AWLUtilities.php') (line 25)
require_once ('EMail.php') (line 27)
require_once ('AwlQuery.php') (line 26)
Variables
resource $session The session object is global. (line 949)

- name: $session The session object is global.

Functions
check_temporary_passwords (line 36)

Checks what a user entered against any currently valid temporary passwords on their account.

- return: Whether or not the user correctly guessed a temporary password within the necessary window of opportunity.

boolean check_temporary_passwords (string $they_sent, int $user_no)

- string $they_sent: What the user entered.
- int $user_no: Which user is attempting to log on.

Documentation generated on Fri, 13 Jan 2012 23:40:17 +1300 by phpDocumentor 1.4.3