[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

/modules/Reports/models/ -> Folder.php (summary)

(no description)

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

Defines 1 class

Reports_Folder_Model:: (22 methods):
  getId()
  setId()
  getName()
  getInstance()
  save()
  delete()
  getReports()
  getDescription()
  getEditUrl()
  getDeleteUrl()
  getInstanceById()
  getAll()
  checkDuplicate()
  hasReports()
  isDefault()
  getInfoArray()
  isEditable()
  isDeletable()
  getReportsCount()
  getAllReportModels()
  getRecordIds()
  getListViewQuery()


Class: Reports_Folder_Model  - X-Ref

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

return: <Number>

setId($value)   X-Ref
Function to set the if for the folder

param: <Number>

getName()   X-Ref
Function to get the name of the folder

return: <String>

getInstance()   X-Ref
Function returns the instance of Folder model

return: <Reports_Folder_Model>

save()   X-Ref
Function saves the folder


delete()   X-Ref
Function deletes the folder


getReports($pagingModel)   X-Ref
Function returns Report Models for the folder

param: <Vtiger_Paging_Model> $pagingModel
return: <Reports_Record_Model>

getDescription()   X-Ref
Function to get the description of the folder

return: <String>

getEditUrl()   X-Ref
Function to get the url for edit folder from list view of the module

return: <string> - url

getDeleteUrl()   X-Ref
Function to get the url for delete folder from list view of the module

return: <string> - url

getInstanceById($folderId)   X-Ref
Function returns the instance of Folder model

param: FolderId
return: <Reports_Folder_Model>

getAll()   X-Ref
Function returns the instance of Folder model

return: <Reports_Folder_Model>

checkDuplicate()   X-Ref
Function returns duplicate record status of the module

return: true if duplicate records exists else false

hasReports()   X-Ref
Function returns whether reports are exist or not in this folder

return: true if exists else false

isDefault()   X-Ref
Function returns whether folder is Default or not

return: true if it is read only else false

getInfoArray()   X-Ref
Function to get info array while saving a folder

return: Array  info array

isEditable()   X-Ref
Function to check whether folder is editable or not

return: <boolean>

isDeletable()   X-Ref
Function to get check whether folder is deletable or not

return: <boolean>

getReportsCount()   X-Ref
Function to calculate number of reports in this folder

return: <Integer>

getAllReportModels($allReportsList, $reportModuleModel)   X-Ref
Function to get all Report Record Models

param: <Array> $allReportsList
param: <Vtiger_Module_Model> - Reports Module Model
return: <Array> Reports Record Models

getRecordIds($skipRecords=false, $module)   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

getListViewQuery($folderId)   X-Ref
Function returns Report Models for the folder

return: <Reports_Record_Model>



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