[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

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

(no description)

File Size: 413 lines (13 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Vtiger_Record_Model:: (32 methods):
  getId()
  setId()
  getName()
  getModule()
  setModule()
  setModuleFromInstance()
  getEntity()
  setEntity()
  getRawData()
  setRawData()
  getDetailViewUrl()
  getFullDetailViewUrl()
  getEditViewUrl()
  getUpdatesUrl()
  getDeleteUrl()
  getModuleName()
  getDisplayName()
  getDisplayValue()
  getField()
  getDisplayableValues()
  save()
  delete()
  getCleanInstance()
  getInstanceById()
  getSearchResult()
  isEditable()
  isDeletable()
  getDuplicateRecordUrl()
  getRelatedListDisplayValue()
  deleteImage()
  getDescriptionValue()
  transferRelationInfoOfRecords()


Class: Vtiger_Record_Model  - X-Ref

Vtiger Entity Record Model Class

getId()   X-Ref
Function to get the id of the record

return: <Number> - Record Id

setId($value)   X-Ref
Function to set the id of the record

param: <type> $value - id value
return: <Object> - current instance

getName()   X-Ref
Fuction to get the Name of the record

return: <String> - Entity Name of the record

getModule()   X-Ref
Function to get the Module to which the record belongs

return: Vtiger_Module_Model

setModule($moduleName)   X-Ref
Function to set the Module to which the record belongs

param: <String> $moduleName
return: Vtiger_Record_Model or Module Specific Record Model instance

setModuleFromInstance($module)   X-Ref
Function to set the Module to which the record belongs from the Module model instance

param: <Vtiger_Module_Model> $module
return: Vtiger_Record_Model or Module Specific Record Model instance

getEntity()   X-Ref
Function to get the entity instance of the recrod

return: CRMEntity object

setEntity($entity)   X-Ref
Function to set the entity instance of the record

param: CRMEntity $entity
return: Vtiger_Record_Model instance

getRawData()   X-Ref
Function to get raw data

return: <Array>

setRawData($data)   X-Ref
Function to set raw data

param: <Array> $data
return: Vtiger_Record_Model instance

getDetailViewUrl()   X-Ref
Function to get the Detail View url for the record

return: <String> - Record Detail View Url

getFullDetailViewUrl()   X-Ref
Function to get the complete Detail View url for the record

return: <String> - Record Detail View Url

getEditViewUrl()   X-Ref
Function to get the Edit View url for the record

return: <String> - Record Edit View Url

getUpdatesUrl()   X-Ref
Function to get the Update View url for the record

return: <String> - Record Upadte view Url

getDeleteUrl()   X-Ref
Function to get the Delete Action url for the record

return: <String> - Record Delete Action Url

getModuleName()   X-Ref
Function to get the name of the module to which the record belongs

return: <String> - Record Module Name

getDisplayName()   X-Ref
Function to get the Display Name for the record

return: <String> - Entity Display Name for the record

getDisplayValue($fieldName,$recordId = false)   X-Ref
Function to retieve display value for a field

param: <String> $fieldName - field name for which values need to get
return: <String>

getField($fieldName)   X-Ref
Function returns the Vtiger_Field_Model

param: <String> $fieldName - field name
return: <Vtiger_Field_Model>

getDisplayableValues()   X-Ref
Function returns all the field values in user format

return: <Array>

save()   X-Ref
Function to save the current Record Model


delete()   X-Ref
Function to delete the current Record Model


getCleanInstance($moduleName)   X-Ref
Static Function to get the instance of a clean Vtiger Record Model for the given module name

param: <String> $moduleName
return: Vtiger_Record_Model or Module Specific Record Model instance

getInstanceById($recordId, $module=null)   X-Ref
Static Function to get the instance of the Vtiger Record Model given the recordid and the module name

param: <Number> $recordId
param: <String> $moduleName
return: Vtiger_Record_Model or Module Specific Record Model instance

getSearchResult($searchKey, $module=false)   X-Ref
Static Function to get the list of records matching the search key

param: <String> $searchKey
return: <Array> - List of Vtiger_Record_Model or Module Specific Record Model instances

isEditable()   X-Ref
Function to get details for user have the permissions to do actions

return: <Boolean> - true/false

isDeletable()   X-Ref
Function to get details for user have the permissions to do actions

return: <Boolean> - true/false

getDuplicateRecordUrl()   X-Ref
Funtion to get Duplicate Record Url

return: <String>

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

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

deleteImage($imageId)   X-Ref
Function to delete corresponding image

param: <type> $imageId

getDescriptionValue()   X-Ref
Function to get Descrption value for this record

return: <String> Descrption

transferRelationInfoOfRecords($recordIds = array()   X-Ref
Function to transfer related records of parent records to this record

param: <Array> $recordIds
return: <Boolean> true/false



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