Methods

getPermKeyFromId()

getPermKeyFromId(integer  $permID) : string

Parameters

integer $permID

Permission id.

Returns

string —

Permission key.

getPermNameFromId()

getPermNameFromId(integer  $permID) : string

Parameters

integer $permID

Permission id.

Returns

string —

Permission name.

getRoleNameFromId()

getRoleNameFromId(integer  $roleID) : string

Parameters

integer $roleID

Role id.

Returns

string —

Role name.

getRoleIDFromKey()

getRoleIDFromKey(string  $roleKey) : integer

Parameters

string $roleKey

Role key.

Returns

integer —

Role id.

getUserRoles()

getUserRoles() : array

Returns

array —

Roles of current user.

getAllRoles()

getAllRoles(string  $format) 

Parameters

string $format

How roles are returned.

getAllPerms()

getAllPerms(string  $format) 

Parameters

string $format

How permissions are returned.

getRolePerms()

getRolePerms(integer  $role) : array

Parameters

integer $role

Role id.

Returns

array —

The permissions of the role.

getUserPerms()

getUserPerms(integer  $user_id) : array

Parameters

integer $user_id

User id.

Returns

array —

The permissions associated with user.

doesUserHaveRole()

doesUserHaveRole(integer  $roleID) : boolean

Parameters

integer $roleID

Role id.

Returns

boolean —

True if user has role, false otherwise.

currentUserCan()

currentUserCan(string  $permKey) : boolean

Parameters

string $permKey

Permission key.

Returns

boolean —

True if user has permission, false otherwise.