SeedDMS_Core_Role
in package
Class to represent a role in the document management system
Tags
Table of Contents
Constants
- role_admin = '1'
- role_guest = '2'
- role_user = '0'
Properties
- $_dms : object
- $_id : int
- $_name : string
- $_noaccess : array<string|int, mixed>
- $_role : string
Methods
- __construct() : mixed
- getAllInstances() : mixed
- getID() : mixed
- getInstance() : object
- Create an instance of a role object
- getName() : mixed
- getNoAccess() : mixed
- getRole() : mixed
- getUsers() : mixed
- isAdmin() : mixed
- isGuest() : mixed
- isUsed() : mixed
- remove() : bool
- Delete role
- setDMS() : mixed
- setName() : mixed
- setNoAccess() : mixed
- setRole() : mixed
Constants
role_admin
public
mixed
role_admin
= '1'
role_guest
public
mixed
role_guest
= '2'
role_user
public
mixed
role_user
= '0'
Properties
$_dms
public
object
$_dms
reference to the dms instance this user belongs to
Tags
$_id
public
int
$_id
id of role
Tags
$_name
public
string
$_name
name of role
Tags
$_noaccess
public
array<string|int, mixed>
$_noaccess
list of status without access
Tags
$_role
public
string
$_role
role of user. Can be one of SeedDMS_Core_Role::role_user, SeedDMS_Core_Role::role_admin, SeedDMS_Core_Role::role_guest
Tags
Methods
__construct()
public
__construct(mixed $id, mixed $name, mixed $role[, mixed $noaccess = array() ]) : mixed
Parameters
- $id : mixed
- $name : mixed
- $role : mixed
- $noaccess : mixed = array()
getAllInstances()
public
static getAllInstances(mixed $orderby, mixed $dms) : mixed
Parameters
- $orderby : mixed
- $dms : mixed
getID()
public
getID() : mixed
getInstance()
Create an instance of a role object
public
static getInstance(string|int $id, object $dms[, string $by = '' ]) : object
Parameters
- $id : string|int
-
Id, login name, or email of user, depending on the 3rd parameter.
- $dms : object
-
instance of dms
- $by : string = ''
-
search by name. If 'name' is passed, the method will search by name instead of id. If this parameter is left empty, the role will be searched by its Id.
Return values
object —instance of class SeedDMS_Core_User
getName()
public
getName() : mixed
getNoAccess()
public
getNoAccess() : mixed
getRole()
public
getRole() : mixed
getUsers()
public
getUsers() : mixed
isAdmin()
public
isAdmin() : mixed
isGuest()
public
isGuest() : mixed
isUsed()
public
isUsed() : mixed
remove()
Delete role
public
remove() : bool
Return values
bool —true on success or false in case of an error
setDMS()
public
setDMS(mixed $dms) : mixed
Parameters
- $dms : mixed
setName()
public
setName(mixed $newName) : mixed
Parameters
- $newName : mixed
setNoAccess()
public
setNoAccess(mixed $noaccess) : mixed
Parameters
- $noaccess : mixed
setRole()
public
setRole(mixed $newrole) : mixed
Parameters
- $newrole : mixed