[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

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

(no description)

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

Defines 1 class

CustomView_Record_Model:: (42 methods):
  getId()
  getOwnerId()
  getOwnerName()
  getModule()
  setModule()
  setModuleFromInstance()
  isDefault()
  isMine()
  isPublic()
  isPrivate()
  isPending()
  isOthers()
  isSetPublic()
  isEditable()
  isDeletable()
  getRecordIds()
  save()
  delete()
  getSelectedFields()
  getStandardCriteria()
  getAdvancedCriteria()
  getCVStdFilterSQL()
  getCVAdvFilterSQL()
  getCreateUrl()
  getEditUrl()
  getApproveUrl()
  getDenyUrl()
  getDeleteUrl()
  approve()
  deny()
  getDateForStdFilterBytype()
  getDateFilterTypes()
  getAdvancedFilterOptions()
  getAdvancedFilterOpsByFieldType()
  getAll()
  getInstanceById()
  getAllByGroup()
  getCleanInstance()
  checkDuplicate()
  transformToNewAdvancedFilter()
  transformStandardFilter()
  getAllFilterByModule()


Class: CustomView_Record_Model  - X-Ref

CustomView Record Model Class

getId()   X-Ref
Function to get the Id

return: <Number> Custom View Id

getOwnerId()   X-Ref
Function to get the Owner Id

return: <Number> Id of the User who created the Custom View

getOwnerName()   X-Ref
Function to get the Owner Name

return: <String> Custom View creator User Name

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

isDefault()   X-Ref
Function to check if the view is marked as default

return: <Boolean> true/false

isMine()   X-Ref
Function to check if the view is created by the current user or is default view

return: <Boolean> true/false

isPublic()   X-Ref
Function to check if the view is approved to be Public

return: <Boolean> true/false

isPrivate()   X-Ref
Function to check if the view is marked as Private

return: <Boolean> true/false

isPending()   X-Ref
Function to check if the view is requested to be Public and is awaiting for Approval

return: <Boolean> true/false

isOthers()   X-Ref
Function to check if the view is created by one of the users, who is below the current user in the role hierarchy

return: <Boolean> true/false

isSetPublic()   X-Ref
Function which checks if a view is set to Public by the user which may/may not be approved.

return: <Boolean> true/false

isEditable()   X-Ref
No description

isDeletable()   X-Ref
No description

getRecordIds($skipRecords=false, $module= false)   X-Ref
Function which provides the records for the current view

param: <Boolean> $skipRecords - List of the RecordIds to be skipped
return: <Array> List of RecordsIds

save()   X-Ref
Function to save the custom view record


delete()   X-Ref
Function to delete the custom view record


getSelectedFields()   X-Ref
Function to get the list of selected fields for the current custom view

return: <Array> List of Field Column Names

getStandardCriteria()   X-Ref
Function to get the Standard filter condition for the current custom view

return: <Array> Standard filter condition

getAdvancedCriteria()   X-Ref
Function to get the list of advanced filter conditions for the current custom view

return: <Array> - All the advanced filter conditions for the custom view, grouped by the condition grouping

getCVStdFilterSQL()   X-Ref
Function returns standard filter sql

return: <String>

getCVAdvFilterSQL()   X-Ref
Function returns Advanced filter sql

return: <String>

getCreateUrl()   X-Ref
Function returns approve url

return: String - approve url

getEditUrl()   X-Ref
Function returns approve url

return: String - approve url

getApproveUrl()   X-Ref
Function returns approve url

return: String - approve url

getDenyUrl()   X-Ref
Function returns deny url

return: String - deny url

getDeleteUrl()   X-Ref
Functions returns delete url

return: String - delete url

approve()   X-Ref
No description

deny()   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>

getAll($moduleName='')   X-Ref
Function to get all the accessible Custom Views, for a given module if specified

param: <String> $moduleName
return: <Array> - Array of Vtiger_CustomView_Record models

getInstanceById($cvId)   X-Ref
Function to get the instance of Custom View module, given custom view id

param: <Integer> $cvId
return: CustomView_Record_Model instance, if exists. Null otherwise

getAllByGroup($moduleName='')   X-Ref
Function to get all the custom views, of a given module if specified, grouped by their status

param: <String> $moduleName
return: <Array> - Associative array of Status label to an array of Vtiger_CustomView_Record models

getCleanInstance()   X-Ref
Function to get Clean instance of this record

return: self

checkDuplicate()   X-Ref
function to check duplicates from database

param: <type> $viewName
param: <type> module name entity type in database
return: <boolean> true/false

transformToNewAdvancedFilter()   X-Ref
Function used to transform the older filter condition to suit newer filters.
The newer filters have only two groups one with ALL(AND) condition between each
filter and other with ANY(OR) condition, this functions tranforms the older
filter with 'AND' condition between filters of a group and will be placed under
match ALL conditions group and the rest of it will be placed under match Any group.

return: <Array>

transformStandardFilter()   X-Ref
No description

getAllFilterByModule($module)   X-Ref
Function gives default custom view for a module

param: <String> $module
return: <CustomView_Record_Model>



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