Documentation

Settings_AutomaticAssignment_Module_Model extends Settings_Vtiger_Module_Model
in package

Automatic assignment module model class.

Tags
copyright

YetiForce Sp. z o.o

license

YetiForce Public License 4.0 (licenses/LicenseEN.txt or yetiforce.com)

author

Radosław Skrzypczak r.skrzypczak@yetiforce.com

Table of Contents

$baseIndex  : string
Table primary key.
$baseTable  : string
Table name.
$listFields  : string
List of fields displayed in list view.
$name  : string
Module Name.
$fieldType  : array<string|int, string>
List of available field types.
autoAssignExecute()  : mixed
Execute auto assign.
clearCache()  : mixed
Function clears cache.
getCreateRecordUrl()  : string
Function to get the url for Create view of the module.
getDefaultUrl()  : string
Function to get the url for default view of the module.
getEditViewUrl()  : string
Function to get the url for edit view of the module.
getFieldsByModule()  : array<string|int, mixed>
List of supported module fields.
getListFields()  : array<string|int, mixed>
{@inheritdoc}
getSupportedModules()  : array<string|int, mixed>
Function get supported modules.
isSortByName()  : bool
Function verifies if it is possible to sort by given field in list view.
searchRecord()  : bool|Settings_AutomaticAssignment_Record_Model
Function searches for record from the Auto assign records panel.

Properties

$baseIndex

Table primary key.

public string $baseIndex = 'id'

$baseTable

Table name.

public string $baseTable = 's_#__automatic_assignment'

$listFields

List of fields displayed in list view.

public string $listFields = ['tabid' => 'FL_MODULE', 'field' => 'FL_FIELD', 'value' => 'FL_VALUE', 'active' => 'FL_ACTIVE', 'roleid' => 'FL_MODE']

$name

Module Name.

public string $name = 'AutomaticAssignment'

$fieldType

List of available field types.

private static array<string|int, string> $fieldType = ['string']

Methods

clearCache()

Function clears cache.

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

getCreateRecordUrl()

Function to get the url for Create view of the module.

public getCreateRecordUrl() : string
Return values
string
  • url

getDefaultUrl()

Function to get the url for default view of the module.

public getDefaultUrl() : string
Return values
string

URL

getEditViewUrl()

Function to get the url for edit view of the module.

public getEditViewUrl() : string
Return values
string
  • url

getFieldsByModule()

List of supported module fields.

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

getListFields()

{@inheritdoc}

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

getSupportedModules()

Function get supported modules.

public static getSupportedModules() : array<string|int, mixed>
Return values
array<string|int, mixed>
  • List of modules

isSortByName()

Function verifies if it is possible to sort by given field in list view.

public isSortByName(string $fieldName) : bool
Parameters
$fieldName : string
Return values
bool

        

Search results