[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/modules/Vtiger/models/ -> Field.php (summary)

(no description)

File Size: 1161 lines (43 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 1 file
 vtlib/Vtiger/Field.php

Defines 1 class

Vtiger_Field_Model:: (62 methods):
  get()
  set()
  getId()
  getName()
  getFieldName()
  getData()
  getModule()
  setModule()
  getDisplayValue()
  getDisplayType()
  getWebserviceFieldObject()
  getFieldDataType()
  getReferenceList()
  isNameField()
  isReadOnly()
  getUITypeModel()
  isRoleBased()
  getPicklistValues()
  isMandatory()
  getFieldType()
  isViewEnabled()
  isViewable()
  isViewableInDetailView()
  isEditEnabled()
  isQuickCreateEnabled()
  isSummaryField()
  isEditable()
  isAjaxEditable()
  getInstanceFromFieldObject()
  getCVDateFilterColumnName()
  getCustomViewColumnName()
  getReportFilterColumnName()
  getWorkFlowFilterColumnName()
  getFieldInfo()
  setFieldInfo()
  getDateForStdFilterBytype()
  getDateFilterTypes()
  getAdvancedFilterOptions()
  getAdvancedFilterOpsByFieldType()
  getAllForModule()
  getInstance()
  getDocumentFolders()
  getProfileReadWritePermission()
  getValidator()
  getEditViewDisplayValue()
  getFileLocationType()
  getCurrencyList()
  getRelatedListDisplayValue()
  getDefaultFieldValue()
  getDBInsertValue()
  getPermissions()
  preFetchModuleFieldPermission()
  __update()
  updateTypeofDataFromMandatory()
  isCustomField()
  hasDefaultValue()
  isActiveField()
  isMassEditable()
  isEmptyPicklistOptionAllowed()
  isReferenceField()
  isOwnerField()
  getInstanceFromFieldId()


Class: Vtiger_Field_Model  - X-Ref

Vtiger Field Model Class

get($propertyName)   X-Ref
Function to get the value of a given property

param: <String> $propertyName
return: <Object>

set($name, $value)   X-Ref
Function which sets value for given name

param: <String> $name - name for which value need to be assinged
param: <type> $value - values that need to be assigned
return: Vtiger_Field_Model

getId()   X-Ref
Function to get the Field Id

return: <Number>

getName()   X-Ref
No description

getFieldName()   X-Ref
No description

getData()   X-Ref
Function to retrieve full data

return: <array>

getModule()   X-Ref
No description

setModule($moduleInstance)   X-Ref
No description

getDisplayValue($value, $record=false, $recordInstance = false)   X-Ref
Function to retieve display value for a value

param: <String> $value - value which need to be converted to display value
return: <String> - converted display value

getDisplayType()   X-Ref
Function to retrieve display type of a field

return: <String> - display type of the field

getWebserviceFieldObject()   X-Ref
Function to get the Webservice Field Object for the current Field Object

return: WebserviceField instance

getFieldDataType()   X-Ref
Function to get the Webservice Field data type

return: <String> Data type of the field

getReferenceList()   X-Ref
Function to get list of modules the field refernced to

return: <Array> -  list of modules for which field is refered to

isNameField()   X-Ref
Function to check if the field is named field of the module

return: <Boolean> - True/False

isReadOnly()   X-Ref
Function to check whether the current field is read-only

return: <Boolean> - true/false

getUITypeModel()   X-Ref
Function to get the UI Type model for the uitype of the current field

return: Vtiger_Base_UIType or UI Type specific model instance

isRoleBased()   X-Ref
No description

getPicklistValues()   X-Ref
Function to get all the available picklist values for the current field

return: <Array> List of picklist values if the field is of type picklist or multipicklist, null otherwise.

isMandatory()   X-Ref
Function to check if the current field is mandatory or not

return: <Boolean> - true/false

getFieldType()   X-Ref
Function to get the field type

return: <String> type of the field

isViewEnabled()   X-Ref
Function to check if the field is shown in detail view

return: <Boolean> - true/false

isViewable()   X-Ref
Function to check if the field is shown in detail view

return: <Boolean> - true/false

isViewableInDetailView()   X-Ref
Function to check if the field is shown in detail view

return: <Boolean> - true/false

isEditEnabled()   X-Ref
No description

isQuickCreateEnabled()   X-Ref
No description

isSummaryField()   X-Ref
Function to check whether summary field or not

return: <Boolean> true/false

isEditable()   X-Ref
Function to check whether the current field is editable

return: <Boolean> - true/false

isAjaxEditable()   X-Ref
Function to check whether field is ajax editable'

return: <Boolean>

getInstanceFromFieldObject(Vtiger_Field $fieldObj)   X-Ref
Static Function to get the instance fo Vtiger Field Model from a given Vtiger_Field object

param: Vtiger_Field $fieldObj - vtlib field object
return: Vtiger_Field_Model instance

getCVDateFilterColumnName()   X-Ref
Function to get the custom view column name transformation of the field for a date field used in date filters

return: <String> - tablename:columnname:fieldname:module_fieldlabel

getCustomViewColumnName()   X-Ref
Function to get the custom view column name transformation of the field

return: <String> - tablename:columnname:fieldname:module_fieldlabel:fieldtype

getReportFilterColumnName()   X-Ref
Function to get the Report column name transformation of the field

return: <String> - tablename:columnname:module_fieldlabel:fieldname:fieldtype

getWorkFlowFilterColumnName()   X-Ref
This is set from Workflow Record Structure, since workflow expects the field name
in a different format in its filter. Eg: for module field its fieldname and for reference
fields its reference_field_name : (reference_module_name) field - salesorder_id: (SalesOrder) subject

return: <String>

getFieldInfo()   X-Ref
Function to get the field details

return: <Array> - array of field values

setFieldInfo($fieldInfo)   X-Ref
No description

getDateForStdFilterBytype($type)   X-Ref
Function to get the date values for the given type of Standard filter

param: <String> $type
return: <Array> - 2 date values representing the range for the given type of Standard filter

getDateFilterTypes()   X-Ref
Function to get all the date filter type informations

return: <Array>

getAdvancedFilterOptions()   X-Ref
Function to get all the supported advanced filter operations

return: <Array>

getAdvancedFilterOpsByFieldType()   X-Ref
Function to get the advanced filter option names by Field type

return: <Array>

getAllForModule($moduleModel)   X-Ref
Function to retrieve field model for specific block and module

param: <Vtiger_Module_Model> $blockModel - block instance
return: <array> List of field model

getInstance($value, $module = false)   X-Ref
Function to get instance

param: <String> $value - fieldname or fieldid
param: <type> $module - optional - module instance
return: <Vtiger_Field_Model>

getDocumentFolders()   X-Ref
Added function that returns the folders in a Document

return: <Array>

getProfileReadWritePermission()   X-Ref
Function checks if the current Field is Read/Write

return: <Boolean>

getValidator()   X-Ref
Function returns Client Side Validators name

return: <Array> [name=>Name of the Validator, params=>Extra Parameters]

getEditViewDisplayValue($value)   X-Ref
Function to retrieve display value in edit view

param: <String> $value - value which need to be converted to display value
return: <String> - converted display value

getFileLocationType()   X-Ref
Function to retieve types of file locations in Documents Edit

return: <array> - List of file location types

getCurrencyList()   X-Ref
Function returns list of Currencies available in the system

return: <Array>

getRelatedListDisplayValue($value)   X-Ref
Function to get Display value for RelatedList

param: <String> $value
return: <String>

getDefaultFieldValue()   X-Ref
Function to get Default Field Value

return: <String> defaultvalue

getDBInsertValue($value)   X-Ref
Function whcih will get the databse insert value format from user format

param: type $value in user format
return: type

getPermissions($accessmode = 'readonly')   X-Ref
Function to get visibilty permissions of a Field

param: <String> $accessmode
return: <Boolean>

preFetchModuleFieldPermission($tabid,$accessmode = 'readonly')   X-Ref
Function to Preinitialize the module Field Permissions

param: <Integer> $tabid
param: <String> $accessmode
return: <Array>

__update()   X-Ref
No description

updateTypeofDataFromMandatory($mandatoryValue='O')   X-Ref
No description

isCustomField()   X-Ref
No description

hasDefaultValue()   X-Ref
No description

isActiveField()   X-Ref
No description

isMassEditable()   X-Ref
No description

isEmptyPicklistOptionAllowed()   X-Ref
Function which will check if empty piclist option should be given


isReferenceField()   X-Ref
No description

isOwnerField()   X-Ref
No description

getInstanceFromFieldId($fieldId, $moduleTabId)   X-Ref
No description



Generated: Fri Nov 28 20:08:37 2014 Cross-referenced by PHPXref 0.7.1