API Documentation
\

\Csz_auth_model

Summary

Methods
Properties
Constants
__construct()
set_pm_clean_max_age()
get_group_id()
get_group_all()
get_perms_all()
get_perm_id()
get_groups_fromuser()
create_group()
update_group()
delete_group()
add_user_group()
remove_user_group()
remove_user_from_allgroup()
is_in_group()
is_useractive()
is_group_allowed()
allow_group()
deny_group()
send_pm()
list_pms()
get_pm()
delete_pm()
cleanup_pms()
count_unread_pms()
set_as_read_pm()
set_as_unread_pm()
$pm_clean_max_age
$db
$dbforge
$config
$load
$session
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$pm_clean_max_age

$pm_clean_max_age :

Type

$db

$db : \CI_DB_query_builder

Type

\CI_DB_query_builder

$dbforge

$dbforge : \CI_DB_forge

Type

\CI_DB_forge

$config

$config : \CI_Config

Type

\CI_Config

$load

$load : \CI_Loader

Type

\CI_Loader

$session

$session : \CI_Session

Type

\CI_Session

Methods

__construct()

__construct()

set_pm_clean_max_age()

set_pm_clean_max_age(string  $max_age)

Get group id Get group id from group name

Parameters

string $max_age

Max age default 3 months

get_group_id()

get_group_id(integer|string  $group_parm) : integer

Get group id Get group id from group name

Parameters

integer|string $group_parm

Group id or name to get

Returns

integer —

Group id or FALSE

get_group_all()

get_group_all(string  $sortby = '') : array

Get get_group_all Get all group

Parameters

string $sortby

Sort by

Returns

array —

Group

get_perms_all()

get_perms_all(string  $type) : array

Get get_perms_all Get all group

Parameters

string $type

Permission type (backend or frontend)

Returns

array —

Perms

get_perm_id()

get_perm_id(integer|string  $perm_parm, string  $type = '') : integer

Get permission id Get permission id from permisison name or id

Parameters

integer|string $perm_parm

Permission id or name to get
string $type

Permission type (backend or frontend) if $perms is id this type can NULL

Returns

integer —

Permission id or NULL if perm does not exist

get_groups_fromuser()

get_groups_fromuser(integer  $user_id = '') : array

Get user from groups Get groups a user is in

Parameters

integer $user_id

User id to get or NULL for current user

Returns

array —

Groups (only 1 row) or FALSE

create_group()

create_group(string  $group_name, string  $definition = '', string  $perms = '') : boolean

create_usergroup

Function for create user group

Parameters

string $group_name

group name
string $definition

for group definition
string $perms

for ferms field array

Returns

boolean —

TRUE or FALSE

update_group()

update_group(string  $user_groups_id, string  $group_name = '', string  $definition = '',   $perms = '')

update_usergroup

Function for update user group

Parameters

string $user_groups_id

group id
string $group_name

group name
string $definition

for group definition
$perms

delete_group()

delete_group(string  $user_groups_id)

delete_usergroup

Function for delete user group

Parameters

string $user_groups_id

group id

add_user_group()

add_user_group(integer  $user_admin_id, integer|string  $group_parm) : boolean

add_user_group Add a user to a group

Parameters

integer $user_admin_id

User id to add to group
integer|string $group_parm

Group id or name to add user

Returns

boolean

remove_user_group()

remove_user_group(integer  $user_admin_id, integer|string  $group_parm)

remove_user_group Remove a user from a group

Parameters

integer $user_admin_id

User id to remove from group
integer|string $group_parm

Group id or name to remove user

remove_user_from_allgroup()

remove_user_from_allgroup(integer  $user_admin_id) : boolean

Remove member Remove a user from all groups

Parameters

integer $user_admin_id

User id to remove from all groups

Returns

boolean —

Remove success/failure

is_in_group()

is_in_group(integer|string  $group_par, integer  $user_admin_id = '') : boolean

Is in group Check if current user is a member of a group

Parameters

integer|string $group_par

Group id or name to check
integer $user_admin_id

User id, if not given current user

Returns

boolean

is_useractive()

is_useractive(integer  $user_admin_id = '') : boolean

is_useractive Check if current user is a member of the admin group

Parameters

integer $user_admin_id

User id to check, if it is not given checks current user

Returns

boolean

is_group_allowed()

is_group_allowed(integer|string  $perm_par, string  $type = '', integer|string  $group_par = '') : boolean

Is Group allowed Check if group is allowed to do specified action, admin always allowed

Parameters

integer|string $perm_par

Permission id or name to check
string $type

Permission type (backend or frontend) if $perms is id this type can NULL
integer|string $group_par

Group id or name to check, or if NULL checks all user groups

Returns

boolean

allow_group()

allow_group(integer|string|boolean  $group_par, integer  $perm_par, string  $type = '') : boolean

Allow Group Add group to permission

Parameters

integer|string|boolean $group_par

Group id or name to allow
integer $perm_par

Permission id or name to allow
string $type

Permission type (backend or frontend) if $perms is id this type can NULL

Returns

boolean —

Allow success/failure

deny_group()

deny_group(integer|string|boolean  $group_par, integer  $perm_par, string  $type = '') : boolean

Deny Group Remove group from permission

Parameters

integer|string|boolean $group_par

Group id or name to deny
integer $perm_par

Permission id or name to deny
string $type

Permission type (backend or frontend) if $perms is id this type can NULL

Returns

boolean —

Deny success/failure

send_pm()

send_pm(array  $receiver_ids, string  $title, string  $message, integer  $sender_id = '', string  $re_message = '') : \array/bool

Send multiple Private Messages Send multiple private messages to another users

Parameters

array $receiver_ids

Array of User ids of private message receiver
string $title

Title/subject
string $message

Message
integer $sender_id

User id of private message sender
string $re_message

Reply the original message

Returns

\array/bool —

Array with User ID's as key and TRUE or a specific error message OR FALSE if sender doesn't exist

list_pms()

list_pms(integer  $limit = 5, integer  $offset, integer  $receiver_id = NULL, integer  $sender_id = NULL,   $unread = FALSE) : object

List Private Messages If receiver id not given retruns current user's pms, if sender_id given, it returns only pms from given sender

Parameters

integer $limit

Number of private messages to be returned
integer $offset

Offset for private messages to be returned (for pagination)
integer $receiver_id

User id of private message receiver
integer $sender_id

User id of private message sender
$unread

Returns

object —

Array of private messages

get_pm()

get_pm(integer  $pm_id,   $user_admin_id = NULL, boolean  $set_as_read = TRUE) : object

Get Private Message Get private message by id

Parameters

integer $pm_id

Private message id to be returned
$user_admin_id
boolean $set_as_read

Whether or not to mark message as read

Returns

object —

Private message

delete_pm()

delete_pm(integer  $pm_id,   $user_admin_id = NULL) : boolean

Delete Private Message Delete private message by id

Parameters

integer $pm_id

Private message id to be deleted
$user_admin_id

Returns

boolean —

Delete success/failure

cleanup_pms()

cleanup_pms()

Cleanup PMs Removes PMs older than 'pm_cleanup_max_age' (definied in aauth config).

recommend for a cron job

count_unread_pms()

count_unread_pms(integer|boolean  $receiver_id = FALSE) : integer

Count unread Private Message Count number of unread private messages

Parameters

integer|boolean $receiver_id

User id for message receiver, if FALSE returns for current user

Returns

integer —

Number of unread messages

set_as_read_pm()

set_as_read_pm(integer  $pm_id)

Set Private Message as read Set private message as read

Parameters

integer $pm_id

Private message id to mark as read

set_as_unread_pm()

set_as_unread_pm(integer  $pm_id)

Set Private Message as unread Set private message as unread

Parameters

integer $pm_id

Private message id to mark as read