UsersManager
in package
Uses
SmartObject
Class UsersManager
Tags
Table of Contents
- COLUMN_ADDED_DT = 'added_dt'
- COLUMN_CREATED_DT = 'created_dt'
- COLUMN_EDITED_DT = 'edited_dt'
- COLUMN_GROUP_ID = 'group_id'
- COLUMN_ID = 'id'
- COLUMN_IS_SUPERUSER = 'is_superuser'
- COLUMN_NAME = 'name'
- COLUMN_PASSWORD_HASH = 'password'
- COLUMN_ROLE = 'role'
- COLUMN_TITLE = 'title'
- TABLE_NAME = 'users'
- $database : Context
- $passwords : Passwords
- $regex_column : array<string|int, mixed>
- $table_cols : array<string|int, mixed>
- __construct() : mixed
- add() : bool|int|ActiveRow
- Adds new user.
- delete() : void
- find() : Selection
- findByName() : ActiveRow|null
- findPairs() : array<string|int, mixed>
- get() : ActiveRow
- getStructurePermissions() : Selection
- get user structure permission
- isGroupUse() : bool
- Check use a group of users
- setPassword() : bool
- setStructureIds() : void
- set user structure
- tableStructuresUsersExists() : bool
- checked StructuresUsers table exists
- update() : void
- validateValue() : array<string|int, mixed>
Constants
COLUMN_ADDED_DT
public
mixed
COLUMN_ADDED_DT
= 'added_dt'
COLUMN_CREATED_DT
public
mixed
COLUMN_CREATED_DT
= 'created_dt'
COLUMN_EDITED_DT
public
mixed
COLUMN_EDITED_DT
= 'edited_dt'
COLUMN_GROUP_ID
public
mixed
COLUMN_GROUP_ID
= 'group_id'
COLUMN_ID
public
mixed
COLUMN_ID
= 'id'
COLUMN_IS_SUPERUSER
public
mixed
COLUMN_IS_SUPERUSER
= 'is_superuser'
COLUMN_NAME
public
mixed
COLUMN_NAME
= 'name'
COLUMN_PASSWORD_HASH
public
mixed
COLUMN_PASSWORD_HASH
= 'password'
COLUMN_ROLE
public
mixed
COLUMN_ROLE
= 'role'
COLUMN_TITLE
public
mixed
COLUMN_TITLE
= 'title'
TABLE_NAME
public
mixed
TABLE_NAME
= 'users'
Properties
$database
private
Context
$database
$passwords
private
Passwords
$passwords
$regex_column
private
array<string|int, mixed>
$regex_column
= []
$table_cols
private
array<string|int, mixed>
$table_cols
= [self::COLUMN_NAME, self::COLUMN_TITLE, self::COLUMN_PASSWORD_HASH, self::COLUMN_IS_SUPERUSER, self::COLUMN_GROUP_ID, self::COLUMN_CREATED_DT, self::COLUMN_ADDED_DT, self::COLUMN_EDITED_DT]
Methods
__construct()
public
__construct(Context $database, Passwords $passwords) : mixed
Parameters
- $database : Context
- $passwords : Passwords
Return values
mixed —add()
Adds new user.
public
add(iteratable<string|int, mixed> $value) : bool|int|ActiveRow
Parameters
- $value : iteratable<string|int, mixed>
Tags
Return values
bool|int|ActiveRow —delete()
public
delete( $id) : void
Parameters
Tags
Return values
void —find()
public
find() : Selection
Return values
Selection —findByName()
public
findByName(string $name) : ActiveRow|null
Parameters
- $name : string
Return values
ActiveRow|null —findPairs()
public
findPairs() : array<string|int, mixed>
Return values
array<string|int, mixed> —get()
public
get( $id) : ActiveRow
Parameters
Tags
Return values
ActiveRow —getStructurePermissions()
get user structure permission
public
getStructurePermissions(int $id) : Selection
Parameters
- $id : int
Return values
Selection —isGroupUse()
Check use a group of users
public
isGroupUse( $group_id) : bool
Parameters
Return values
bool —setPassword()
public
setPassword( $id, $password) : bool
Parameters
Tags
Return values
bool —setStructureIds()
set user structure
public
setStructureIds(int $userId, bool $isCanViewChildren, bool $isCanViewCurrent, array<string|int, mixed> $structuresIds) : void
Parameters
- $userId : int
- $isCanViewChildren : bool
- $isCanViewCurrent : bool
- $structuresIds : array<string|int, mixed>
Tags
Return values
void —tableStructuresUsersExists()
checked StructuresUsers table exists
public
tableStructuresUsersExists() : bool
Return values
bool —update()
public
update(int $id, iteratable<string|int, mixed> $value) : void
Parameters
- $id : int
- $value : iteratable<string|int, mixed>
Tags
Return values
void —validateValue()
private
validateValue(iteratable<string|int, mixed> $values) : array<string|int, mixed>
Parameters
- $values : iteratable<string|int, mixed>