Documentation

Settings_Picklist_Module_Model extends Vtiger_Module_Model
in package

Table of Contents

addDescriptionColumn()  : bool
Add description column to picklist.
addPickListValues()  : array<string|int, int>
Add value to picklist.
addPrefixColumn()  : bool
Add description column to picklist.
checkColumn()  : bool
Check description column in picklist.
enableOrDisableValuesForRole()  : mixed
getFieldsByType()  : array<string|int, mixed>
{@inheritdoc}
getInstance()  : self
Static Function to get the instance of Vtiger Module Model for the given id or name.
getInstanceFromModuleObject()  : self
Function to get the instance of Vtiger Module Model from a given vtlib\Module object.
getPicklistSupportedModules()  : mixed
listModuleInterdependentPickList()  : array<string|int, mixed>
list of modules in which they appear picklist fields.
remove()  : mixed
renamePickListValues()  : bool
Rename picklist value.
updateSequence()  : mixed
Function to update sequence number.

Methods

addDescriptionColumn()

Add description column to picklist.

public addDescriptionColumn(string $tableName) : bool
Parameters
$tableName : string
Return values
bool

addPickListValues()

Add value to picklist.

public addPickListValues(Vtiger_Field_Model $fieldModel, string $newValue[, array<string|int, int> $rolesSelected = [] ][, string $description = '' ][, string $prefix = '' ]) : array<string|int, int>
Parameters
$fieldModel : Vtiger_Field_Model
$newValue : string
$rolesSelected : array<string|int, int> = []
$description : string = ''
$prefix : string = ''
Return values
array<string|int, int>

addPrefixColumn()

Add description column to picklist.

public addPrefixColumn(string $tableName) : bool
Parameters
$tableName : string
Return values
bool

checkColumn()

Check description column in picklist.

public static checkColumn(string $tableName, string $columnName) : bool
Parameters
$tableName : string
$columnName : string
Return values
bool

enableOrDisableValuesForRole()

public enableOrDisableValuesForRole(mixed $picklistFieldName, mixed $valuesToEnables, mixed $valuesToDisable, mixed $roleIdList) : mixed
Parameters
$picklistFieldName : mixed
$valuesToEnables : mixed
$valuesToDisable : mixed
$roleIdList : mixed
Return values
mixed

getFieldsByType()

{@inheritdoc}

public getFieldsByType(mixed $type[, bool $active = false ]) : array<string|int, mixed>
Parameters
$type : mixed
$active : bool = false
Return values
array<string|int, mixed>

getInstance()

Static Function to get the instance of Vtiger Module Model for the given id or name.

public static getInstance(mixed $value) : self
Parameters
$value : mixed
Return values
self

getInstanceFromModuleObject()

Function to get the instance of Vtiger Module Model from a given vtlib\Module object.

public static getInstanceFromModuleObject(Module $moduleObj) : self
Parameters
$moduleObj : Module
Return values
self

instance

getPicklistSupportedModules()

public static getPicklistSupportedModules() : mixed
Return values
mixed

listModuleInterdependentPickList()

list of modules in which they appear picklist fields.

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

remove()

public remove(mixed $pickListFieldName, mixed $valueToDeleteId, mixed $replaceValueId, mixed $moduleName) : mixed
Parameters
$pickListFieldName : mixed
$valueToDeleteId : mixed
$replaceValueId : mixed
$moduleName : mixed
Return values
mixed

renamePickListValues()

Rename picklist value.

public renamePickListValues(Settings_Picklist_Field_Model $fieldModel, string $oldValue, string $newValue, int $id[, string $description = '' ][, string $prefix = '' ]) : bool
Parameters
$fieldModel : Settings_Picklist_Field_Model
$oldValue : string
$newValue : string
$id : int
$description : string = ''
$prefix : string = ''
Return values
bool

updateSequence()

Function to update sequence number.

public updateSequence(string $pickListFieldName, array<string|int, mixed> $picklistValues) : mixed
Parameters
$pickListFieldName : string
$picklistValues : array<string|int, mixed>
Return values
mixed

        

Search results