User

Return to documentation ↩

public $user
public __construct()
Initiate User object
public __destruct()
Terminate User object, save user in session
return void
public hook($orbit=null)
Perform Orbit hook
Orbit $orbit
return void
public auth($username='', $password='', $remember=false)
Login user by username, password
string $username
string $password
bool $remember
return bool True if successful
public deauth()
Logout user, destroy "remember me" data
return void
public perm($required=false, $permission=null)
Verify user has permission to access module
bool $required Redirects (on failure) if true
string $permission Permission string
return void
public setPref($name='', $unset='')
Set preference key
string $name
string $unset
return void
public readPref($name='', $check=true)
Read preference key and return value in HTML
string $name
string $check
return void
public returnPref($name='', $default=null)
Read preference key and return value
string $name
string $default
return void
public savePref()
Save preferences
return void
public updateFields($fields=array(), $overwrite=true)
Update user table
string $fields Associative array of columns and fields
bool $overwrite
return void
public email($subject='', $message='')
Send email to user
string $subject
string $message
return void
protected authByCookie($user_id=0, $user_key='', $remember=true)
Login user by ID, key
string $user_id
string $user_key
bool $remember
return bool True if successful
private prep($remember=false)
Prepare user for functionality
bool $remember
return bool True if successful