Documentation » API Reference

Application:

Class: SessionManager_User



Properties

$access = array ()

$status = array ()

$roles = array ()

$teams = array ()

$resources = array ()

$user = array ()

$prefs = array ()

$_prefs = array ()

$path

$realm

$cancelmessage = 'You do not have permission to access this resource.'

$cookiename = 'sitellite_session_id'

  • Access: public

Name of the cookie. Defaults to 'sitellite_session_id'.

$cookieexpires = 0

  • Access: public

Expiration of cookie. Defaults to 0, which means the cookie
will expire when the browser closes.

$cookiedomain

  • Access: public

Domain value of the cookie.

$cookiepath = '/'

  • Access: public

Path value of the cookie. Defaults to '/'.

$cookiesecure = 0

  • Access: public

Secure value of the cookie. May be 1 or 0, and defaults to 0.

$usernamefield = 'username'

  • Access: public

The name of the username field in the form (uses saf.MailForm)
created by sendAuthRequest(). Defaults to 'username'.

$passwordfield = 'password'

  • Access: public

The name of the password field in the form
created by sendAuthRequest(). Defaults to 'password'.

$hiddenfields = array ()

  • Access: public

A list of hidden form fields and their values.

$usernametext = 'Username'

  • Access: public

The alt text of the username field in the form
created by sendAuthRequest(). Defaults to 'Username'.

$passwordtext = 'Password'

  • Access: public

The alt text of the password field in the form
created by sendAuthRequest(). Defaults to 'Password'.

$submittext = 'Sign In'

  • Access: public

The alt text of the submit button in the form
created by sendAuthRequest(). Defaults to 'Sign In'.

$formtemplate = false

  • Access: public

The template of the form created by sendAuthRequest().
Defaults to false (no template).

$usernamerules = array ()

  • Access: public

A list of rules for the username form field. The keys are
the rules and the values are the invalid messages.

$passwordrules = array ()

  • Access: public

A list of rules for the password form field. The keys are
the rules and the values are the invalid messages.

$formmessage = 'Please enter your username and password.'

  • Access: public

The welcome message of the form. Defaults to
'Please enter your username and password.'

$invalidmessage = 'Sorry, the password you specified was invalid. Please try again.'

  • Access: public

The invalid message of the form. Defaults to
'Sorry, the password you specified was invalid. Please try again.'

$timeoutmessage = 'Sorry, your session has timed out.  Please sign in again to continue.'

  • Access: public

The timeout message of the form. Defaults to
'Sorry, your session has timed out. Please sign in again to continue.'

$sessObj

  • Access: public

A reference to the main session object, in case it's
needed by a specific handler.

$error

Error message, if an error occurs.

$total

Number of users.

Return to Top



Methods

getList ($offset = false, $limit = false, $order, $ascdesc, $role = false, $team = false, $name = false, $disabled = false, $public = false, $teams = false) 

  • Return: array

Returns a list of users.

add ($data) 

  • Return: boolean

Adds a user to the system.

edit ($user, $data) 

  • Return: boolean

Modifies a user in the system.

delete ($user) 

  • Return: boolean

Deletes a user from the system.

&getAddForm () 

  • Return: object saf.MailForm object

Generate a form for adding items to this list.

&getEditForm ($item) 

  • Return: object saf.MailForm object

Generate a form for editing items in this list.

Return to Top