Methods

Check for login (final method to (un)register verification, work is done by _check())

check() : bool

Returns

bool

Remove any remember-me cookie stored

dont_remember_me() 

forge()

forge(array $config) 

Parameters

$config

Get emailaddress of the current logged in user

get_email() : string

Returns

string

Get User Groups of the current logged in user in the form: array(array(driver_id, group_id), array(driver_id, group_id), etc)

get_groups() : array

Returns

array

Get screen name of the current logged in user

get_screen_name() : string

Returns

string

Return user info in an array, always includes email & screen_name Additional fields can be requested in the first param or set in config, all additional fields must have their own method "get_" + fieldname

get_user_array(array $additional_fields) : array

Parameters

$additional_fields

array

additional fields

Returns

array

Get User Identifier of the current logged in user in the form: array(driver_id, user_id)

get_user_id() : array

Returns

array

Returns the list of defined groups

groups($driver) : array

Parameters

$driver

Returns

array

Verify Acl access

has_access(mixed $condition, string $driver, array $entity) : bool

Parameters

$condition

mixed

condition to validate

$driver

string

acl driver id or null to check all

$entity

array

user identifier to check in form array(driver_id, user_id)

Returns

bool

Default password hash method

hash_password($password) : string

Parameters

$password

string

Returns

string

Logout method

logout() 

Verify Group membership

member(mixed $group, string $driver, array $user) : bool

Parameters

$group

mixed

group identifier to check for membership

$driver

string

group driver id or null to check all

$user

array

user identifier to check in form array(driver_id, user_id)

Returns

bool

Set a remember-me cookie for the passed user id, or for the current logged-in user if no id was given

remember_me($user_id) : bool

Parameters

$user_id

Returns

boolwhether or not the cookie was set

Returns the list of defined roles

roles($driver) : array

Parameters

$driver

Returns

array

Perform the actual login check

validate_user() : bool

Returns

bool

Perform the actual login check

perform_check() : bool

Returns

bool

 Properties

 

<p>default instance</p>

$_instance : \Auth\Auth_Driver

 

<p>contains references if multiple were loaded</p>

$_instances : array

 

<p>config values</p>

$config : array

 

<p>session object for the remember-me feature</p>

$remember_me : \Auth\Session_Cookie