Documentation

Settings_Picklist_Module_Model extends Settings_Vtiger_Module_Model
in package

Table of Contents

$name  : string
$parent  : string
$sourceModule  : Vtiger_Module_Model
$fields  : array<string|int, Settings_Picklist_Field_Model>
enableOrDisableValuesForRole()  : void
Enable or disable values for role.
getFieldByName()  : Vtiger_Field_Model
Get fields instance by name.
getFieldsByType()  : array<string|int, mixed>
{@inheritdoc}
getInstanceFromModuleObject()  : self
Function to get the instance of Vtiger Module Model from a given vtlib\Module object.
listModuleInterdependentPickList()  : array<string|int, mixed>
list of modules in which they appear picklist fields.
setSourceModule()  : $this
Set source module.
updateSequence()  : mixed
Function to update sequence number.

Properties

$name

public string $name = 'Picklist'

Module name

$parent

public string $parent = 'Settings'

Parent name

$sourceModule

public Vtiger_Module_Model $sourceModule

Source module model

Methods

enableOrDisableValuesForRole()

Enable or disable values for role.

public enableOrDisableValuesForRole(string $picklistFieldName, array<string|int, string> $valuesToEnables, array<string|int, string> $valuesToDisable, array<string|int, string> $roleIdList) : void
Parameters
$picklistFieldName : string
$valuesToEnables : array<string|int, string>
$valuesToDisable : array<string|int, string>
$roleIdList : array<string|int, string>
Return values
void —

getFieldByName()

Get fields instance by name.

public getFieldByName(string $name) : Vtiger_Field_Model
Parameters
$name : string
Return values
Vtiger_Field_Model —

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> —

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

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> —

setSourceModule()

Set source module.

public setSourceModule(string $sourceModule) : $this
Parameters
$sourceModule : string
Return values
$this —

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