Field
extends FieldBasic
in package
Provides APIs to control vtiger CRM Field.
Table of Contents
- $__cacheSchemaChanges : mixed
- Cache (Record) the schema changes to improve performance
- $anonymizationTarget : array<string|int, string>
- $block : mixed
- $color : mixed
- $column : mixed
- $columntype : mixed
- $defaultvalue : mixed
- $displaytype : mixed
- $fieldparams : mixed
- $generatedtype : mixed
- $header_field : mixed
- $helpinfo : mixed
- $icon : mixed
- $id : mixed
- ID of this field instance
- $info_type : mixed
- $label : mixed
- $masseditable : mixed
- $maximumlength : mixed
- $maxlengthtext : mixed
- $maxwidthcolumn : mixed
- $name : mixed
- $presence : mixed
- $quickcreate : mixed
- $quicksequence : mixed
- $readonly : mixed
- $sequence : mixed
- $summaryfield : mixed
- $tabid : mixed
- $tabindex : mixed
- $table : mixed
- $typeofdata : mixed
- $uitype : mixed
- $visible : mixed
- __create() : mixed
- Create this field instance.
- __delete() : mixed
- Delete this field instance.
- __getNextQuickCreateSequence() : mixed
- Get next quick create sequence id for this instance.
- __getNextSequence() : mixed
- Get next sequence id to use within a block for this instance.
- __update() : mixed
- delete() : mixed
- Delete this field instance.
- deleteForModule() : mixed
- Delete fields associated with the module.
- deletePickLists() : mixed
- Function to remove picklist-type or multiple choice picklist-type table.
- deleteUiType10Fields() : mixed
- Function to remove uitype10 fields.
- getAllForBlock() : mixed
- Get Field instances related to block.
- getAllForModule() : self
- Get Field instances related to module.
- getBlockId() : mixed
- Get block id to which this field instance is associated.
- getBlockName() : string
- Get block name.
- getInstance() : Field|bool
- Get Field instance by fieldid or fieldname.
- getModuleId() : mixed
- Get module id to which this field instance is associated.
- getModuleInstance() : mixed
- Get module instance to which this field instance is associated.
- getModuleName() : bool|string
- Get module name to which this field instance is associated.
- getPicklistValues() : mixed
- Get picklist values from table.
- initialize() : mixed
- Initialize this instance.
- save() : mixed
- Save this field instance.
- setHelpInfo() : mixed
- Set Help Information for this instance.
- setMassEditable() : mixed
- Set Masseditable information for this instance.
- setNoRolePicklistValues() : mixed
- Set values for picklist field (non-role based).
- setPicklistValues() : mixed
- Set values for picklist field (for all the roles).
- setSummaryField() : mixed
- Set Summaryfield information for this instance.
- setTreeTemplate() : mixed
- unsetRelatedModules() : mixed
- Remove relation between the field and modules (UIType 10).
- clearCache() : void
- Clear cache.
Properties
$__cacheSchemaChanges
Cache (Record) the schema changes to improve performance
public
static mixed
$__cacheSchemaChanges
= []
$anonymizationTarget
public
array<string|int, string>
$anonymizationTarget
= []
Anonymization targets form field ex. logs.
$block
public
mixed
$block
$color
public
mixed
$color
= ''
$column
public
mixed
$column
= false
$columntype
public
mixed
$columntype
= false
$defaultvalue
public
mixed
$defaultvalue
= ''
$displaytype
public
mixed
$displaytype
= 1
$fieldparams
public
mixed
$fieldparams
= ''
$generatedtype
public
mixed
$generatedtype
= 1
$header_field
public
mixed
$header_field
= false
$helpinfo
public
mixed
$helpinfo
= ''
$icon
public
mixed
$icon
= ''
$id
ID of this field instance
public
mixed
$id
$info_type
public
mixed
$info_type
= 'BAS'
$label
public
mixed
$label
= ''
$masseditable
public
mixed
$masseditable
= 1
$maximumlength
public
mixed
$maximumlength
$maxlengthtext
public
mixed
$maxlengthtext
= 0
$maxwidthcolumn
public
mixed
$maxwidthcolumn
= 0
$name
public
mixed
$name
$presence
public
mixed
$presence
= 2
$quickcreate
public
mixed
$quickcreate
= 1
$quicksequence
public
mixed
$quicksequence
= false
$readonly
public
mixed
$readonly
= 0
$sequence
public
mixed
$sequence
= false
$summaryfield
public
mixed
$summaryfield
= 0
$tabid
public
mixed
$tabid
= false
$tabindex
public
mixed
$tabindex
= 0
$table
public
mixed
$table
= false
$typeofdata
public
mixed
$typeofdata
= 'V~O'
$uitype
public
mixed
$uitype
= 1
$visible
public
mixed
$visible
= 0
Methods
__create()
Create this field instance.
public
__create(mixed $blockInstance) : mixed
Parameters
- $blockInstance : mixed
Return values
mixed —__delete()
Delete this field instance.
public
__delete() : mixed
Return values
mixed —__getNextQuickCreateSequence()
Get next quick create sequence id for this instance.
public
__getNextQuickCreateSequence() : mixed
Return values
mixed —__getNextSequence()
Get next sequence id to use within a block for this instance.
public
__getNextSequence() : mixed
Return values
mixed —__update()
public
__update() : mixed
Return values
mixed —delete()
Delete this field instance.
public
delete() : mixed
Return values
mixed —deleteForModule()
Delete fields associated with the module.
public
static deleteForModule(ModuleBasic $moduleInstance) : mixed
Parameters
- $moduleInstance : ModuleBasic
Return values
mixed —deletePickLists()
Function to remove picklist-type or multiple choice picklist-type table.
public
static deletePickLists(mixed $moduleInstance) : mixed
Parameters
- $moduleInstance : mixed
Return values
mixed —deleteUiType10Fields()
Function to remove uitype10 fields.
public
static deleteUiType10Fields(mixed $moduleInstance) : mixed
Parameters
- $moduleInstance : mixed
Return values
mixed —getAllForBlock()
Get Field instances related to block.
public
static getAllForBlock(mixed $blockInstance[, mixed $moduleInstance = false ]) : mixed
Parameters
- $blockInstance : mixed
- $moduleInstance : mixed = false
Return values
mixed —getAllForModule()
Get Field instances related to module.
public
static getAllForModule(ModuleBasic $moduleInstance) : self
Parameters
- $moduleInstance : ModuleBasic
Return values
self —getBlockId()
Get block id to which this field instance is associated.
public
getBlockId() : mixed
Return values
mixed —getBlockName()
Get block name.
public
getBlockName() : string
Return values
string —getInstance()
Get Field instance by fieldid or fieldname.
public
static getInstance(string|int $value[, Module $moduleInstance = false ]) : Field|bool
Parameters
- $value : string|int
-
mixed fieldid or fieldname
- $moduleInstance : Module = false
-
Instance of the module if fieldname is used
Return values
Field|bool —getModuleId()
Get module id to which this field instance is associated.
public
getModuleId() : mixed
Return values
mixed —getModuleInstance()
Get module instance to which this field instance is associated.
public
getModuleInstance() : mixed
Return values
mixed —getModuleName()
Get module name to which this field instance is associated.
public
getModuleName() : bool|string
Return values
bool|string —getPicklistValues()
Get picklist values from table.
public
getPicklistValues() : mixed
Return values
mixed —initialize()
Initialize this instance.
public
initialize(array<string|int, mixed> $valuemap[, mixed $module = false ][, Block $blockInstance = false ]) : mixed
Parameters
- $valuemap : array<string|int, mixed>
- $module : mixed = false
-
Mixed id or name of the module
- $blockInstance : Block = false
-
Instance of block to which this field belongs
Return values
mixed —save()
Save this field instance.
public
save([mixed $blockInstance = false ]) : mixed
Parameters
- $blockInstance : mixed = false
Return values
mixed —setHelpInfo()
Set Help Information for this instance.
public
setHelpInfo(mixed $helptext) : mixed
Parameters
- $helptext : mixed
Return values
mixed —setMassEditable()
Set Masseditable information for this instance.
public
setMassEditable(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setNoRolePicklistValues()
Set values for picklist field (non-role based).
public
setNoRolePicklistValues(mixed $values) : mixed
Parameters
- $values : mixed
Return values
mixed —setPicklistValues()
Set values for picklist field (for all the roles).
public
setPicklistValues(mixed $values) : mixed
Parameters
- $values : mixed
Return values
mixed —setSummaryField()
Set Summaryfield information for this instance.
public
setSummaryField(mixed $value) : mixed
Parameters
- $value : mixed
Return values
mixed —setTreeTemplate()
public
setTreeTemplate(mixed $tree, mixed $moduleInstance) : mixed
Parameters
- $tree : mixed
- $moduleInstance : mixed
Return values
mixed —unsetRelatedModules()
Remove relation between the field and modules (UIType 10).
public
unsetRelatedModules(mixed $moduleNames) : mixed
Parameters
- $moduleNames : mixed
Return values
mixed —clearCache()
Clear cache.
protected
clearCache() : void