Users_Module_Model
extends Vtiger_Module_Model
in package
Table of Contents
- checkMailExist() : bool
- Check mail exist.
- checkUserName() : bool
- Validation of user name.
- getAlphabetSearchField() : string
- Function returns the default column for Alphabetic search.
- getCreateRecordUrl() : string
- Function to get the url for the Create Record view of the module.
- getDefaultUrl() : mixed
- getFieldsForSave() : array<string|int, string>
- Function gives list fields for save.
- getListViewUrl() : string
- Function to get the url for list view of the module.
- getLoginHistory() : array<string|int, mixed>
- Get user login history.
- getQueryByModuleField() : mixed
- Function to get list view query for popup window.
- getQueryForRecords() : QueryGenerator
- {@inheritdoc}
- getSwitchUsers() : array<string|int, mixed>
- Get switch users.
- isCustomViewAdvCondEnabled() : bool
- {@inheritdoc}
- isUtilityActionEnabled() : mixed
- {@inheritdoc}
- isWorkflowSupported() : mixed
- {@inheritdoc}
- saveLoginHistory() : void
- Function to store the login history.
- saveLogoutHistory() : mixed
- Function to store the logout history.
Methods
checkMailExist()
Check mail exist.
public
static checkMailExist(string $email[, false|int $userId = false ]) : bool
Parameters
- $email : string
- $userId : false|int = false
Return values
bool —checkUserName()
Validation of user name.
public
static checkUserName(string $userName[, false|int $userId = false ]) : bool
Parameters
- $userName : string
- $userId : false|int = false
Return values
bool —getAlphabetSearchField()
Function returns the default column for Alphabetic search.
public
getAlphabetSearchField() : string
Return values
string —columnname
getCreateRecordUrl()
Function to get the url for the Create Record view of the module.
public
getCreateRecordUrl() : string
Return values
string —- url
getDefaultUrl()
public
getDefaultUrl() : mixed
Return values
mixed —getFieldsForSave()
Function gives list fields for save.
public
getFieldsForSave(Vtiger_Record_Model $recordModel) : array<string|int, string>
Parameters
- $recordModel : Vtiger_Record_Model
Return values
array<string|int, string> —getListViewUrl()
Function to get the url for list view of the module.
public
getListViewUrl() : string
Return values
string —- url
getLoginHistory()
Get user login history.
public
static getLoginHistory([int|null $limit = null ]) : array<string|int, mixed>
Parameters
- $limit : int|null = null
Return values
array<string|int, mixed> —getQueryByModuleField()
Function to get list view query for popup window.
public
getQueryByModuleField(string $sourceModule, string $field, string $record, QueryGenerator $queryGenerator) : mixed
Parameters
- $sourceModule : string
-
Parent module
- $field : string
-
parent fieldname
- $record : string
-
parent id
- $queryGenerator : QueryGenerator
Return values
mixed —getQueryForRecords()
{@inheritdoc}
public
getQueryForRecords(string $searchValue, int $limit[, int $srcRecord = null ]) : QueryGenerator
Parameters
- $searchValue : string
- $limit : int
- $srcRecord : int = null
Return values
QueryGenerator —getSwitchUsers()
Get switch users.
public
static getSwitchUsers([bool $showRole = false ]) : array<string|int, mixed>
Parameters
- $showRole : bool = false
Return values
array<string|int, mixed> —isCustomViewAdvCondEnabled()
{@inheritdoc}
public
isCustomViewAdvCondEnabled() : bool
Return values
bool —isUtilityActionEnabled()
{@inheritdoc}
public
isUtilityActionEnabled() : mixed
Return values
mixed —isWorkflowSupported()
{@inheritdoc}
public
isWorkflowSupported() : mixed
Return values
mixed —saveLoginHistory()
Function to store the login history.
public
saveLoginHistory(string $userName, string $status) : void
Parameters
- $userName : string
- $status : string
Return values
void —saveLogoutHistory()
Function to store the logout history.
public
saveLogoutHistory() : mixed