Sitellite Application Framework
Class Tree         Index         All Elements

Element index for package Session

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ m ] [ p ] [ r ] [ s ] [ t ] [ u ] [ v ] [ _ ]

_

$_prefs
in file Acl.php, variable SessionAcl::$_prefs
top

a

$access
in file Acl.php, variable SessionAcl::$access
$autoSave
in file Session.php, variable Session::$autoSave
    Specifies whether calls to set() should also call save() automatically. Defaults to true, since for most intents and purposes this is a nice way of not having to think about it.
add
in file Manager.php, method SessionManager_Simple::add()
    Adds an item to $data and rewrites the INI file.
add
in file Manager.php, method SessionManager_Role::add()
    Adds an item to $data and rewrites the INI file.
add
in file Manager.php, method SessionManager_Team::add()
    Adds an item to $data and rewrites the INI file.
add
in file Manager.php, method SessionManager_User::add()
    Adds a user to the system.
add
in file Database.php, method SessionSource_Database::add()
    Adds a new user.
add
in file Source.php, method SessionSource::add()
    Adds a new user.
add
in file Manager.php, method SessionManager_Pref::add()
    Adds an item to $data and rewrites the INI file.
adminRoles
in file Acl.php, method SessionAcl::adminRoles()
    Returns the list of roles which are admins.
allowed
in file Session.php, method Session::allowed()
    Specifies whether the user is allowed to access the requested resource. $resource may be a string, or an object or associative array with the properties name, sitellite_acces, and sitellite_status.
allowed
in file Acl.php, method SessionAcl::allowed()
    Specifies whether the user is allowed to access the requested
allowedAccessList
in file Acl.php, method SessionAcl::allowedAccessList()
    Returns an array of allowed access levels for the current user.
allowedSql
in file Acl.php, method SessionAcl::allowedSql()
    Returns a piece of SQL that can be slipped into the WHERE clause of a query to check for proper permissions.
allowedSql
in file Session.php, method Session::allowedSql()
    Returns a piece of SQL that can be slipped into the WHERE clause of a query to check for proper permissions.
allowedStatusList
in file Acl.php, method SessionAcl::allowedStatusList()
    Returns an array of allowed statuses for the current user. If the
allowedTeamsList
in file Acl.php, method SessionAcl::allowedTeamsList()
    Returns an array of allowed teams for the current user. If the
append
in file Session.php, method Session::append()
    Sets an array value in the session store. If the array
approvedSql
in file Acl.php, method SessionAcl::approvedSql()
    Returns a piece of SQL that can be slipped into the WHERE clause of
authorize
in file Database.php, method SessionSource_Database::authorize()
    Authorizes the user against the database.
authorize
in file Session.php, method Session::authorize()
    Check the autorization of a user but do not log them in. Useful for web services or external applications requiring authentication but which should not log the person out on the website through their use.
authorize
in file Source.php, method SessionSource::authorize()
    Authorizes the user against the data source.
Acl.php
procedural page Acl.php
top

b

Basic.php
procedural page Basic.php
top

c

$cancelmessage
in file Basic.php, variable SessionHandler_Basic::$cancelmessage
$connection
in file Store.php, variable SessionStore::$connection
    The store connection resource, if applicable to the individual driver.
$cookiedomain
in file Cookie.php, variable SessionHandler_Cookie::$cookiedomain
    Domain value of the cookie.
$cookiedomain
in file PHP.php, variable SessionStore_PHP::$cookiedomain
    Domain value of the cookie.
$cookieexpires
in file PHP.php, variable SessionStore_PHP::$cookieexpires
    The lifetime of the session cookie.
$cookieexpires
in file Cookie.php, variable SessionHandler_Cookie::$cookieexpires
    Expiration of cookie. Defaults to 0, which means the cookie will expire when the browser closes.
$cookiename
in file Cookie.php, variable SessionHandler_Cookie::$cookiename
    Name of the cookie. Defaults to 'sitellite_session_id'.
$cookiepath
in file PHP.php, variable SessionStore_PHP::$cookiepath
    Path value of the cookie. Defaults to '/'.
$cookiepath
in file Cookie.php, variable SessionHandler_Cookie::$cookiepath
    Path value of the cookie. Defaults to '/'.
$cookiesecure
in file Cookie.php, variable SessionHandler_Cookie::$cookiesecure
    Secure value of the cookie. May be 1 or 0, and defaults to 0.
$cookiesecure
in file PHP.php, variable SessionStore_PHP::$cookiesecure
    If 1 then the cookie will only be sent over secure connections.
changeTimeout
in file Handler.php, method SessionHandler::changeTimeout()
    Resets the client info with a new timeout value.
changeTimeout
in file Cookie.php, method SessionHandler_Cookie::changeTimeout()
    Re-sends the session cookie with a new timeout value.
close
in file Source.php, method SessionSource::close()
    Closes the session with the source.
close
in file Store.php, method SessionStore::close()
    Closes the session with the store, erasing the values for this session.
close
in file Session.php, method Session::close()
    Closes the session handler, source, and the store. Call this to log a user out and terminate their session. Please note: when a session is terminated, all data stored in it that is not written to a permanent storage location is lost.
close
in file PHP.php, method SessionStore_PHP::close()
    Closes the session with the store, erasing the values for this session.
close
in file Database.php, method SessionSource_Database::close()
    Closes the session with the source. In this case, explicitly removes the user's session info from the database.
close
in file Cookie.php, method SessionHandler_Cookie::close()
    Unsets the session cookie.
close
in file Handler.php, method SessionHandler::close()
    Closes the session with the user.
Cookie.php
procedural page Cookie.php
top

d

$data
in file Manager.php, variable SessionManager_Pref::$data
    Parsed data from file.
$data
in file Manager.php, variable SessionManager_Simple::$data
    Parsed data from file.
$data
in file Manager.php, variable SessionManager_Team::$data
    Parsed data from file.
$data
in file Manager.php, variable SessionManager_Role::$data
    Parsed data from file.
$dir
in file Manager.php, variable SessionManager_Role::$dir
    Directory to store info.
$disabledcolumn
in file Database.php, variable SessionSource_Database::$disabledcolumn
    The name of the disabled column in the database.
delete
in file Manager.php, method SessionManager_Team::delete()
    Deletes an item from $data and rewrites the INI file.
delete
in file Source.php, method SessionSource::delete()
    Removes the specified user.
delete
in file Manager.php, method SessionManager_User::delete()
    Deletes a user from the system.
delete
in file Manager.php, method SessionManager_Simple::delete()
    Deletes an item from $data and rewrites the INI file.
delete
in file Manager.php, method SessionManager_Role::delete()
    Deletes an item from $data and rewrites the INI file.
delete
in file Database.php, method SessionSource_Database::delete()
    Removes the specified user.
delete
in file Manager.php, method SessionManager_Pref::delete()
    Deletes an item from $data and rewrites the INI file.
Database.php
procedural page Database.php
top

e

$encryptionMethod
in file Database.php, variable SessionSource_Database::$encryptionMethod
    The method to use to compare the password to the
$error
in file Manager.php, variable SessionManager_Team::$error
    Error message, if an error occurs.
$error
in file Session.php, variable Session::$error
    Contains the error message if any error occurs within this class, the handler or the source drivers, or false if no error has occurred.
$error
in file Manager.php, variable SessionManager_User::$error
    Error message, if an error occurs.
$error
in file Manager.php, variable SessionManager_Simple::$error
    Error message, if an error occurs.
$error
in file Source.php, variable SessionSource::$error
    The error message if an error occurs.
$error
in file Handler.php, variable SessionHandler::$error
    The error message if an error occurs.
$error
in file Manager.php, variable SessionManager_Pref::$error
    Error message, if an error occurs.
$error
in file Store.php, variable SessionStore::$error
    The error message if an error occurs.
$error
in file Manager.php, variable SessionManager_Role::$error
    Error message, if an error occurs.
edit
in file Manager.php, method SessionManager_User::edit()
    Modifies a user in the system.
edit
in file Manager.php, method SessionManager_Simple::edit()
    Renames an item in $data and rewrites the INI file.
edit
in file Manager.php, method SessionManager_Pref::edit()
    Renames an item in $data and rewrites the INI file.
edit
in file Manager.php, method SessionManager_Role::edit()
    Renames an item in $data and rewrites the INI file.
edit
in file Manager.php, method SessionManager_Team::edit()
    Renames an item in $data and rewrites the INI file.
top

f

$file
in file Manager.php, variable SessionManager_Simple::$file
    File to store info.
$file
in file Manager.php, variable SessionManager_Status::$file
    File to store status info.
$file
in file Manager.php, variable SessionManager_Team::$file
    File to store info.
$file
in file Manager.php, variable SessionManager_Resource::$file
    File to store resource info.
$file
in file Manager.php, variable SessionManager_Pref::$file
    File to store info.
$file
in file Manager.php, variable SessionManager_Access::$file
    File to store access info.
$formmessage
in file Cookie.php, variable SessionHandler_Cookie::$formmessage
    The welcome message of the form. Defaults to 'Please enter your username and password.'
$formtemplate
in file Cookie.php, variable SessionHandler_Cookie::$formtemplate
    The template of the form created by sendAuthRequest().
top

g

gatherParameters
in file Session.php, method Session::gatherParameters()
    Retrieves the appropriate username, password, and session id
gatherParameters
in file Basic.php, method SessionHandler_Basic::gatherParameters()
gatherParameters
in file Cookie.php, method SessionHandler_Cookie::gatherParameters()
    Provides values for the username, password, and session id (if applicable) to the main Session object. This is passed off to the handlers because they know more about the client than the main object does.
get
in file Session.php, method Session::get()
    Retrieves a value from the session store. Returns false if the value does not exist.
get
in file Store.php, method SessionStore::get()
    Retrieves a value from the session store. Returns false if the value does not exist.
get
in file PHP.php, method SessionStore_PHP::get()
    Retrieves a value from the session store. Returns false if the value does not exist.
getActive
in file Source.php, method SessionSource::getActive()
    Retrieves the total number of active (ie. currently logged in) users.
getActive
in file Database.php, method SessionSource_Database::getActive()
    Retrieves the total number of active (ie. currently logged in) users.
getAddForm
in file Manager.php, method SessionManager_User::getAddForm()
    Generate a form for adding items to this list.
getAddForm
in file Manager.php, method SessionManager_Role::getAddForm()
    Generate a form for adding items to this list.
getAddForm
in file Manager.php, method SessionManager_Team::getAddForm()
    Generate a form for adding items to this list.
getAddForm
in file Manager.php, method SessionManager_Pref::getAddForm()
    Generate a form for adding items to this list.
getData
in file Manager.php, method SessionManager_Pref::getData()
    Retrieves the data from $file and stores it in $data.
getData
in file Manager.php, method SessionManager_Role::getData()
    Retrieves the data from and stores it in $data.
getData
in file Manager.php, method SessionManager_Simple::getData()
    Retrieves the data from $file and stores it in $data.
getData
in file Manager.php, method SessionManager_Team::getData()
    Retrieves the data from $file and stores it in $data.
getEditForm
in file Manager.php, method SessionManager_User::getEditForm()
    Generate a form for editing items in this list.
getEditForm
in file Manager.php, method SessionManager_Team::getEditForm()
    Generate a form for editing items in this list.
getEditForm
in file Manager.php, method SessionManager_Role::getEditForm()
    Generate a form for editing items in this list.
getEditForm
in file Manager.php, method SessionManager_Pref::getEditForm()
    Generate a form for editing items in this list.
getList
in file Database.php, method SessionSource_Database::getList()
    Retrieves a list of users.
getList
in file Manager.php, method SessionManager_Team::getList()
    Returns an array of the data.
getList
in file Source.php, method SessionSource::getList()
    Retrieves a list of users.
getList
in file Manager.php, method SessionManager_User::getList()
    Returns a list of users.
getList
in file Manager.php, method SessionManager_Simple::getList()
    Returns an array of the data.
getList
in file Manager.php, method SessionManager_Pref::getList()
    Returns an array of the data.
getList
in file Manager.php, method SessionManager_Role::getList()
    Returns an array of the data.
getManager
in file Session.php, method Session::getManager()
    Retrieves a copy of the session manager object.
getRole
in file Source.php, method SessionSource::getRole()
    Returns the role of the current user.
getRole
in file Database.php, method SessionSource_Database::getRole()
    Returns the role of the current user.
getTeam
in file Source.php, method SessionSource::getTeam()
    Returns the team of the current user.
getTeam
in file Database.php, method SessionSource_Database::getTeam()
    Returns the team of the current user.
getTeams
in file Source.php, method SessionSource::getTeams()
    Returns the list of teams whose documents are accessible by the current user.
getTeams
in file Database.php, method SessionSource_Database::getTeams()
    Returns the list of teams whose documents are accessible by the current user.
getTotal
in file Source.php, method SessionSource::getTotal()
    Retrieves the total number of users. $role and $team allow you to retrieve a total for specific roles and teams. $public allows you to specify whether to limit it to public users or not.
getTotal
in file Database.php, method SessionSource_Database::getTotal()
    Retrieves the total number of users. $role and $team allow you to retrieve a total for specific roles and teams.
getUser
in file Source.php, method SessionSource::getUser()
    Retrieves a user by their username. Returns all of the user's data as an object.
getUser
in file Session.php, method Session::getUser()
    Finds a user by their email address.
getUser
in file Database.php, method SessionSource_Database::getUser()
    Retrieves a user by their username.
getUserByEmail
in file Source.php, method SessionSource::getUserByEmail()
    Retrieves a user by their email address. Returns just the username.
getUserByEmail
in file Session.php, method Session::getUserByEmail()
    Finds a user by their email address.
getUserByEmail
in file Database.php, method SessionSource_Database::getUserByEmail()
    Retrieves a user by their email address.
top

h

$handler
in file Session.php, variable Session::$handler
    The handler driver object.
$hiddenfields
in file Cookie.php, variable SessionHandler_Cookie::$hiddenfields
    A list of hidden form fields and their values.
Handler.php
procedural page Handler.php
top

i

$id
in file Session.php, variable Session::$id
    The session id value.
$invalidmessage
in file Cookie.php, variable SessionHandler_Cookie::$invalidmessage
    The invalid message of the form. Defaults to 'Sorry, the password you specified was invalid. Please try again.'
init
in file Session.php, method Session::init()
    Initializes the session objects, which is necessary to do outside of the constructor because a constructor can't properly reference $this inside of itself it seems.
init
in file Acl.php, method SessionAcl::init()
initPrefs
in file Acl.php, method SessionAcl::initPrefs()
isAdmin
in file Acl.php, method SessionAcl::isAdmin()
    Determines whether the current user belongs to an administrative role.
isDisabled
in file Source.php, method SessionSource::isDisabled()
    Returns the whether or not the current user account is disabled.
isDisabled
in file Database.php, method SessionSource_Database::isDisabled()
    Returns the whether or not the current user account is disabled.
isResource
in file Acl.php, method SessionAcl::isResource()
    Determines whether the specified resource name exists.
isValidKey
in file Source.php, method SessionSource::isValidKey()
    Determines whether the specified verification key is valid.
isValidKey
in file Session.php, method Session::isValidKey()
    Checks the validity of the specified recovery key.
isValidKey
in file Database.php, method SessionSource_Database::isValidKey()
    Determines whether the specified verification key is valid.
top

m

$map
in file Source.php, variable SessionSource::$map
    Source fields to map to the specified fields.
makePendingKey
in file Session.php, method Session::makePendingKey()
    Creates a 32 character string of the form 'PENDING:' plus a 24 character long random string. Used for creating pending accounts.
makeRecoverKey
in file Session.php, method Session::makeRecoverKey()
    Creates a 32 character string of the form 'RECOVER:' plus a 24 character long random string. Used for recovering passwords.
Manager.php
procedural page Manager.php
top

p

$password
in file Session.php, variable Session::$password
    Contains the password of the user.
$passwordcolumn
in file Database.php, variable SessionSource_Database::$passwordcolumn
    The name of the password column in the database.
$passwordfield
in file Cookie.php, variable SessionHandler_Cookie::$passwordfield
    The name of the password field in the form created by sendAuthRequest(). Defaults to 'password'.
$passwordrules
in file Cookie.php, variable SessionHandler_Cookie::$passwordrules
    A list of rules for the password form field. The keys are the rules and the values are the invalid messages.
$passwordtext
in file Cookie.php, variable SessionHandler_Cookie::$passwordtext
    The alt text of the password field in the form created by sendAuthRequest(). Defaults to 'Password'.
$path
in file Acl.php, variable SessionAcl::$path
$prefs
in file Acl.php, variable SessionAcl::$prefs
$publiccolumn
in file Database.php, variable SessionSource_Database::$publiccolumn
    The name of the public column in the database.
pref
in file Acl.php, method SessionAcl::pref()
    Returns the value of the specified preference setting.
prefSet
in file Acl.php, method SessionAcl::prefSet()
    Alters the value of the specified preference setting, in the current session AND in the database. Returns false on failure to update.
PHP.php
procedural page PHP.php
top

r

$readOnly
in file Source.php, variable SessionSource::$readOnly
    If this is set to true, the session source is considered "read-only" and can't be modified via Sitellite's user administration capabilities.
$realm
in file Basic.php, variable SessionHandler_Basic::$realm
$resources
in file Acl.php, variable SessionAcl::$resources
$resultObj
in file Source.php, variable SessionSource::$resultObj
    An object containing all of the values returned from the data source regarding the user.
$rolecolumn
in file Database.php, variable SessionSource_Database::$rolecolumn
    The name of the role column in the database.
$roles
in file Acl.php, variable SessionAcl::$roles
top

s

$sessionidcolumn
in file Database.php, variable SessionSource_Database::$sessionidcolumn
    The name of the session id column in the database.
$session_name
in file PHP.php, variable SessionStore_PHP::$session_name
    The error message if an error occurs. Defaults to 'sitellite_session_id'.
$sessObj
in file Handler.php, variable SessionHandler::$sessObj
    A reference to the main session object, in case it's needed by a specific handler.
$sessObj
in file Source.php, variable SessionSource::$sessObj
    A reference to the main session object, in case it's needed by a specific handler.
$sessObj
in file Store.php, variable SessionStore::$sessObj
    A reference to the main session object, in case it's needed by a specific handler.
$set
in file Source.php, variable SessionSource::$set
    User values to set automatically to the specified values.
$source
in file Session.php, variable Session::$source
    The source driver object.
$status
in file Acl.php, variable SessionAcl::$status
$store
in file Session.php, variable Session::$store
    The store driver object.
$submittext
in file Cookie.php, variable SessionHandler_Cookie::$submittext
    The alt text of the submit button in the form created by sendAuthRequest(). Defaults to 'Sign In'.
save
in file PHP.php, method SessionStore_PHP::save()
    Tells the session store to save the values within it.
save
in file Session.php, method Session::save()
    Tells the session store to save the values within it.
save
in file Store.php, method SessionStore::save()
    Tells the session store to save the values within it.
sendAuthRequest
in file Cookie.php, method SessionHandler_Cookie::sendAuthRequest()
    Sends the request for a username and password. This would be an HTML form in this case.
sendAuthRequest
in file Handler.php, method SessionHandler::sendAuthRequest()
    Sends an authorization request to the user.
sendAuthRequest
in file Basic.php, method SessionHandler_Basic::sendAuthRequest()
    Sends the request for a username and password.
sendAuthRequest
in file Session.php, method Session::sendAuthRequest()
    This method issues a request for authorization to the visitor.
Session
in file Session.php, class Session
    Session is a class that manages visitor sessions.
Session
in file Session.php, method Session::Session()
    Constructor method.
SessionAcl
in file Acl.php, method SessionAcl::SessionAcl()
SessionAcl
in file Acl.php, class SessionAcl
SessionHandler
in file Handler.php, method SessionHandler::SessionHandler()
    Constructor method.
SessionHandler
in file Handler.php, class SessionHandler
    This is the base client handler package for saf.Session. Custom handlers are created by sub-classing this package.
SessionHandler_Basic
in file Basic.php, class SessionHandler_Basic
    Provides an HTTP Basic authentication client handler to the saf.Session Package.
SessionHandler_Cookie
in file Cookie.php, class SessionHandler_Cookie
    Provides a Cookie-based authentication client handler to the saf.Session Package.
SessionManager
in file Manager.php, class SessionManager
SessionManager
in file Manager.php, method SessionManager::SessionManager()
SessionManager_Access
in file Manager.php, class SessionManager_Access
SessionManager_Pref
in file Manager.php, class SessionManager_Pref
SessionManager_Pref
in file Manager.php, method SessionManager_Pref::SessionManager_Pref()
    Constructor method.
SessionManager_Resource
in file Manager.php, class SessionManager_Resource
SessionManager_Role
in file Manager.php, class SessionManager_Role
SessionManager_Role
in file Manager.php, method SessionManager_Role::SessionManager_Role()
    Constructor method.
SessionManager_Simple
in file Manager.php, class SessionManager_Simple
    Handles INI files of the format:
SessionManager_Simple
in file Manager.php, method SessionManager_Simple::SessionManager_Simple()
    Constructor method.
SessionManager_Status
in file Manager.php, class SessionManager_Status
SessionManager_Team
in file Manager.php, class SessionManager_Team
SessionManager_Team
in file Manager.php, method SessionManager_Team::SessionManager_Team()
    Constructor method.
SessionManager_User
in file Manager.php, class SessionManager_User
SessionSource
in file Source.php, class SessionSource
    This is the base source driver package for saf.Session. Custom drivers are created by sub-classing this package.
SessionSource
in file Source.php, method SessionSource::SessionSource()
    Constructor method.
SessionSource_Database
in file Database.php, class SessionSource_Database
    This is the Database source driver package for saf.Session.
SessionStore
in file Store.php, method SessionStore::SessionStore()
    Constructor method.
SessionStore
in file Store.php, class SessionStore
    This is the base store driver package for saf.Session. Custom drivers are created by sub-classing this package.
SessionStore_PHP
in file PHP.php, class SessionStore_PHP
    This is the base store driver package for saf.Session. Custom drivers are created by sub-classing this package.
SessionStore_PHP
in file PHP.php, method SessionStore_PHP::SessionStore_PHP()
    Constructor method.
session_admin
in file Acl.php, function session_admin()
    Alias of SessionAcl->isAdmin().
session_admin_roles
in file Acl.php, function session_admin_roles()
session_allowed
in file Acl.php, function session_allowed()
    Alias of SessionAcl->allowed().
session_allowed_access_list
in file Acl.php, function session_allowed_access_list()
    Alias of SessionAcl->allowedAccessList().
session_allowed_sql
in file Acl.php, function session_allowed_sql()
    Alias of SessionAcl->allowedSql().
session_allowed_status_list
in file Acl.php, function session_allowed_status_list()
    Alias of SessionAcl->allowedStatusList().
session_allowed_teams_list
in file Acl.php, function session_allowed_teams_list()
    Alias of SessionAcl->allowedTeamsList().
session_append
in file Session.php, function session_append()
    Appends to the value of the specified session variable.
session_approved_sql
in file Acl.php, function session_approved_sql()
    Alias of SessionAcl->approvedSql().
session_authorize
in file Session.php, function session_authorize()
session_change_timeout
in file Handler.php, function session_change_timeout()
    Alias of SessionHandler's changeTimeout() method.
session_get
in file Session.php, function session_get()
    Retrieves the value of the specified session variable.
session_get_access_levels
in file Acl.php, function session_get_access_levels()
    Alias of SessionAcl->access.
session_get_manager
in file Session.php, function session_get_manager()
    Retrieves a copy of the session manager object.
session_get_resources
in file Acl.php, function session_get_resources()
    Alias of SessionAcl->resources.
session_get_roles
in file Acl.php, function session_get_roles()
    Retrieves a list of all roles.
session_get_statuses
in file Acl.php, function session_get_statuses()
    Alias of SessionAcl->status.
session_get_teams
in file Acl.php, function session_get_teams()
    Retrieves a list of all teams.
session_get_user
in file Session.php, function session_get_user()
session_is_resource
in file Acl.php, function session_is_resource()
session_is_valid_key
in file Session.php, function session_is_valid_key()
session_make_pending_key
in file Session.php, function session_make_pending_key()
session_password
in file Session.php, function session_password()
    Retrieves the current user's encrypted password from the global $session object. Useful for custom authentication situations, such as the changing of one's password.
session_pref
in file Acl.php, function session_pref()
    Alias of SessionAcl->pref().
session_pref_list
in file Acl.php, function session_pref_list()
    Alias of SessionAcl->prefs.
session_pref_set
in file Acl.php, function session_pref_set()
    Alias of SessionAcl->prefSet().
session_role
in file Acl.php, function session_role()
    Alias of SessionAcl->user['role'].
session_save
in file Session.php, function session_save()
    Saves the current user's session data.
Session.php
procedural page Session.php
session_set
in file Session.php, function session_set()
    Modifies the value of the specified session variable.
Source.php
procedural page Source.php
Store.php
procedural page Store.php
session_team
in file Acl.php, function session_team()
    Alias of SessionAcl->user['team'].
session_username
in file Session.php, function session_username()
    Retrieves the current user's username from the global $session object.
session_user_add
in file Source.php, function session_user_add()
    Alias of $GLOBALS['session']->source->add().
session_user_delete
in file Source.php, function session_user_delete()
    Alias of $GLOBALS['session']->source->delete().
session_user_edit
in file Source.php, function session_user_edit()
    Alias of $GLOBALS['session']->source->update(). Note however, the reversal of the property order.
session_user_error
in file Source.php, function session_user_error()
    Alias of $GLOBALS['session']->source->error.
session_user_get
in file Source.php, function session_user_get()
    Alias of $GLOBALS['session']->source->getUser().
session_user_get_active
in file Source.php, function session_user_get_active()
    Alias of $GLOBALS['session']->source->getActive().
session_user_get_email
in file Source.php, function session_user_get_email()
    Retrieves the email address of the specified user.
session_user_get_list
in file Source.php, function session_user_get_list()
    Alias of $GLOBALS['session']->source->getList().
session_user_get_total
in file Source.php, function session_user_get_total()
    Alias of $GLOBALS['session']->source->getTotal().
session_user_is_unique
in file Source.php, function session_user_is_unique()
    Determines whether the specified username exists.
session_user_total
in file Source.php, function session_user_total()
    Alias of $GLOBALS['session']->source->total.
session_valid
in file Session.php, function session_valid()
    Determines whether the current user is valid.
set
in file Session.php, method Session::set()
    Sets a value in the session store. If the value is false,
set
in file Store.php, method SessionStore::set()
    Sets a value in the session store. If the value is false, it will unset it in the store. If the value is being unset or set to a new value, then the old value is returned. If it is a new value, then the value itself will be returned.
set
in file PHP.php, method SessionStore_PHP::set()
    Sets a value in the session store. If the value is false, it will unset it in the store. If the value is being unset or set to a new value, then the old value is returned. If it is a new value, then the value itself will be returned.
setHandlerProperties
in file Session.php, method Session::setHandlerProperties()
    Sets any custom properties of the handler driver.
setProperties
in file Handler.php, method SessionHandler::setProperties()
    Sets the properties of this object.
setProperties
in file Store.php, method SessionStore::setProperties()
    Sets the properties of this object.
setProperties
in file Source.php, method SessionSource::setProperties()
    Sets the properties of this object.
setSourceProperties
in file Session.php, method Session::setSourceProperties()
    Sets any custom properties of the source driver.
setStoreProperties
in file Session.php, method Session::setStoreProperties()
    Sets any custom properties of the store driver.
setTimeout
in file Session.php, method Session::setTimeout()
    Sets the value of the $timeout property.
start
in file Store.php, method SessionStore::start()
    Starts the session store, initializing any necessary connections, and retrieving any session values found from a previous web page request.
start
in file Session.php, method Session::start()
    Starts the session logic. This is typically the stage where the username/password or session id will be verified, so after this stage you will be able to check the $valid property to see if the user is valid.
start
in file Cookie.php, method SessionHandler_Cookie::start()
    Initializes the communication with the client. In the case of this handler, if the $authorized value is true it sets the session cookie with the $id value.
start
in file Handler.php, method SessionHandler::start()
    Initializes the communication with the client.
start
in file PHP.php, method SessionStore_PHP::start()
    Starts the session store, initializing any necessary connections, and retrieving any session values found from a previous web page request.
start
in file Basic.php, method SessionHandler_Basic::start()
top

t

$tablename
in file Database.php, variable SessionSource_Database::$tablename
    The name of the database table that contains the users.
$teamcolumn
in file Database.php, variable SessionSource_Database::$teamcolumn
    The name of the team column in the database.
$teams
in file Acl.php, variable SessionAcl::$teams
$teamscolumn
in file Database.php, variable SessionSource_Database::$teamscolumn
    The name of the teams column in the database.
$timeout
in file Session.php, variable Session::$timeout
    Specifies a length in seconds that the session may be inactive for before automatically logging the user out. This is also optional, as some handlers or sources may not support it.
$timeoutcolumn
in file Database.php, variable SessionSource_Database::$timeoutcolumn
    The name of the timeout column in the database.
$timeoutmessage
in file Cookie.php, variable SessionHandler_Cookie::$timeoutmessage
    The timeout message of the form. Defaults to 'Sorry, your session has timed out. Please sign in again to continue.'
$total
in file Manager.php, variable SessionManager_User::$total
    Number of users.
top

u

$useID
in file Session.php, variable Session::$useID
    Specifies whether or not to use a session id. Some handlers or sources may not support session ids (ie. the Basic handler), and so they may be disabled.
$user
in file Acl.php, variable SessionAcl::$user
$username
in file Session.php, variable Session::$username
    Contains the username of the user.
$usernamecolumn
in file Database.php, variable SessionSource_Database::$usernamecolumn
    The name of the username column in the database.
$usernamefield
in file Cookie.php, variable SessionHandler_Cookie::$usernamefield
    The name of the username field in the form (uses saf.MailForm) created by sendAuthRequest(). Defaults to 'username'.
$usernamerules
in file Cookie.php, variable SessionHandler_Cookie::$usernamerules
    A list of rules for the username form field. The keys are the rules and the values are the invalid messages.
$usernametext
in file Cookie.php, variable SessionHandler_Cookie::$usernametext
    The alt text of the username field in the form created by sendAuthRequest(). Defaults to 'Username'.
update
in file Source.php, method SessionSource::update()
    Updates the data of the specified user.
update
in file Database.php, method SessionSource_Database::update()
    Updates the data of the specified user.
update
in file Session.php, method Session::update()
    Updates the user's data in the data source. May update another user than the current one by specifying a username as the second parameter.
top

v

$valid
in file Session.php, variable Session::$valid
    Says whether this session is valid.
verify
in file Acl.php, method SessionAcl::verify()
top

Copyright © 2007, SIMIAN systems Inc.
All rights reserved. Privacy policy
Documentation generated on Tue, 13 Feb 2007 17:16:31 -0600 by Sitellite AppDoc and phpDocumentor 1.2.2