Documentation

Settings_Picklist_Field_Model extends Vtiger_Field_Model
in package

Table of Contents

getInstance()  : self
Function to get instance.
getInstanceFromFieldObject()  : Vtiger_Field_Model
Static Function to get the instance fo Vtiger Field Model from a given vtlib\Field object.
getPicklistValuesForRole()  : type
Function which will give the picklistvalues for given roleids.
isEditable()  : bool
Function to check whether the current field is editable.
isProcessStatusField()  : bool
Is process status field.
updateCloseState()  : bool
Update close state table.
updateRecordStatus()  : bool
Update record status.
validate()  : mixed
Verification of data.

Methods

getInstance()

Function to get instance.

public static getInstance(string|int $value[, Settings_Picklist_Module_Model|Vtiger_Module_Model|bool $module = false ]) : self
Parameters
$value : string|int

fieldname or fieldid

$module : Settings_Picklist_Module_Model|Vtiger_Module_Model|bool = false

module instance

Return values
self

getInstanceFromFieldObject()

Static Function to get the instance fo Vtiger Field Model from a given vtlib\Field object.

public static getInstanceFromFieldObject(Field $fieldObj) : Vtiger_Field_Model
Parameters
$fieldObj : Field
  • vtlib field object
Return values
Vtiger_Field_Model

instance

getPicklistValuesForRole()

Function which will give the picklistvalues for given roleids.

public getPicklistValuesForRole(type $roleIdList[, type $groupMode = 'INTERSECTION' ]) : type
Parameters
$roleIdList : type

-- array of role ids

$groupMode : type = 'INTERSECTION'

-- Intersection/Conjuction , intersection will give only picklist values that exist for all roles

Return values
type

-- array

isEditable()

Function to check whether the current field is editable.

public isEditable() : bool
Return values
bool

isProcessStatusField()

Is process status field.

public isProcessStatusField() : bool
Return values
bool

updateCloseState()

Update close state table.

public updateCloseState(int $valueId, string $value[, bool|null $closeState = null ]) : bool
Parameters
$valueId : int
$value : string
$closeState : bool|null = null
Tags
throws
Exception
throws
AppException
Return values
bool

updateRecordStatus()

Update record status.

public updateRecordStatus(int $id, int $recordState, int $timeCounting) : bool
Parameters
$id : int
$recordState : int
$timeCounting : int
Tags
throws
AppException
Return values
bool

validate()

Verification of data.

public validate(string $value[, int $id = false ]) : mixed
Parameters
$value : string
$id : int = false
Tags
throws
Exception
Return values
mixed

        

Search results