YetiForce PHP Documentation

Settings_Users_Module_Model extends Settings_Vtiger_Module_Model
in package

Settings users module model class.

Table of Contents

$users  : array<string|int, mixed>
Users array.
$usersID  : array<string|int, mixed>
Users id.
getConfig()  : array<string|int, mixed>
Get config.
getInstance()  : self
Get instance.
getLocks()  : array<string|int, mixed>
Function to get locks.
getLocksTypes()  : array<string|int, string>
Return type of locks.
getSwitchUsers()  : array<string|int, mixed>
Returns the list of users to switch.
getUserID()  : int
Get user id.
getUserName()  : string
Get user name by id.
refreshSwitchUsers()  : mixed
Refresh list users to switch.
saveLocks()  : mixed
Function to save locks for users.
saveSwitchUsers()  : mixed
Save configuration about switching between users.
setConfig()  : bool
Set config type, parameter value pair.

Properties

$users

Users array.

public static array<string|int, mixed> $users = []

$usersID

Users id.

public static array<string|int, mixed> $usersID = []

Methods

getConfig()

Get config.

public static getConfig(string $type) : array<string|int, mixed>
Parameters
$type : string
Return values
array<string|int, mixed>

getInstance()

Get instance.

public static getInstance([string $name = 'Settings:Vtiger' ]) : self
Parameters
$name : string = 'Settings:Vtiger'
Return values
self

getLocks()

Function to get locks.

public getLocks() : array<string|int, mixed>
Return values
array<string|int, mixed>

getLocksTypes()

Return type of locks.

public getLocksTypes() : array<string|int, string>
Return values
array<string|int, string>

getSwitchUsers()

Returns the list of users to switch.

public getSwitchUsers() : array<string|int, mixed>
Return values
array<string|int, mixed>

getUserID()

Get user id.

public getUserID(string $data) : int
Parameters
$data : string
Return values
int

getUserName()

Get user name by id.

public getUserName(int $id) : string
Parameters
$id : int
Return values
string

refreshSwitchUsers()

Refresh list users to switch.

public refreshSwitchUsers() : mixed
Return values
mixed

saveLocks()

Function to save locks for users.

public saveLocks(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

saveSwitchUsers()

Save configuration about switching between users.

public saveSwitchUsers(array<string|int, mixed> $data) : mixed
Parameters
$data : array<string|int, mixed>
Return values
mixed

setConfig()

Set config type, parameter value pair.

public static setConfig(array<string|int, mixed> $param) : bool
Parameters
$param : array<string|int, mixed>
Return values
bool

Search results