[ Index ]

PHP Cross Reference of vtigercrm-6.1.0

title

Body

[close]

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

(no description)

File Size: 1160 lines (40 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 2 files
 modules/Reports/models/Report.php
 modules/Reports/ReportUtils.php

Defines 1 class

Reports_Record_Model:: (66 methods):
  getId()
  setId()
  getName()
  delete()
  getDetailViewUrl()
  getEditViewUrl()
  getDuplicateRecordUrl()
  getReportExcelURL()
  getReportCSVURL()
  getReportPrintURL()
  getInstanceById()
  getCleanInstance()
  initialize()
  getPrimaryModule()
  getSecondaryModules()
  setPrimaryModule()
  setSecondaryModule()
  getReportType()
  getOwner()
  isEditable()
  getReportRelatedModules()
  getModulesList()
  getPrimaryModuleFields()
  getSecondaryModuleFields()
  getSelectedFields()
  getSelectedCalculationFields()
  getSelectedSortFields()
  getSelectedStandardFilter()
  getSelectedAdvancedFilter()
  save()
  saveSortFields()
  saveCalculationFields()
  saveStandardFilter()
  saveSharingInformation()
  saveSelectedFields()
  saveAdvancedFilters()
  saveScheduleInformation()
  deleteScheduling()
  getReportSQL()
  generateCountQuery()
  getReportData()
  getReportsCount()
  getReportCalulationData()
  getReportXLS()
  getReportCSV()
  getReportPrint()
  isDefault()
  move()
  getPrimaryModuleCalculationFields()
  getSecondaryModuleCalculationFields()
  getCalculationFields()
  transformToNewAdvancedFilter()
  transformStandardFilter()
  getAdvancedFilterSQL()
  generateData()
  generateCalculationData()
  checkDuplicate()
  showLineItemFieldsInFilter()
  getScheduledReport()
  getRecordsListFromRequest()
  getModuleCalculationFieldsForReport()
  getAggregateFunctions()
  saveReportType()
  getReportTypeInfo()
  getPrimaryModuleFieldsForAdvancedReporting()
  getSecondaryModuleFieldsForAdvancedReporting()


Class: Reports_Record_Model  - X-Ref

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

return: <Number> - Report Id

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

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

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

return: <String>

delete()   X-Ref
Function deletes the Report

return: Boolean

getDetailViewUrl()   X-Ref
Function to get the detail view url

return: <String>

getEditViewUrl()   X-Ref
Function to get the edit view url

return: <String>

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

return: <String>

getReportExcelURL()   X-Ref
Function returns the url that generates Report in Excel format

return: <String>

getReportCSVURL()   X-Ref
Function returns the url that generates Report in CSV format

return: <String>

getReportPrintURL()   X-Ref
Function returns the url that generates Report in printable format

return: <String>

getInstanceById($recordId)   X-Ref
Function returns the Reports Model instance

param: <Number> $recordId
param: <String> $module
return: <Reports_Record_Model>

getCleanInstance($recordId = null)   X-Ref
Function creates Reports_Record_Model

param: <Number> $recordId
return: <Reports_Record_Model>

initialize()   X-Ref
Function initializes Report


getPrimaryModule()   X-Ref
Function returns Primary Module of the Report

return: <String>

getSecondaryModules()   X-Ref
Function returns Secondary Module of the Report

return: <String>

setPrimaryModule($module)   X-Ref
Function sets the Primary Module of the Report

param: <String> $module

setSecondaryModule($modules)   X-Ref
Function sets the Secondary Modules for the Report

param: <String> $modules, modules separated with colon(:)

getReportType()   X-Ref
Function returns Report Type(Summary/Tabular)

return: <String>

getOwner()   X-Ref
Returns the Reports Owner

return: <Number>

isEditable()   X-Ref
Function checks if the Report is editable

return: boolean

getReportRelatedModules()   X-Ref
Function returns Report enabled Modules

return: type

getModulesList()   X-Ref
No description

getPrimaryModuleFields()   X-Ref
Function returns Primary Module Fields

return: <Array>

getSecondaryModuleFields()   X-Ref
Function returns Secondary Module fields

return: <Array>

getSelectedFields()   X-Ref
Function returns Report Selected Fields

return: <Array>

getSelectedCalculationFields()   X-Ref
Function returns Report Calculation Fields

return: type

getSelectedSortFields()   X-Ref
Function returns Report Sort Fields

return: type

getSelectedStandardFilter()   X-Ref
Function returns Reports Standard Filters

return: type

getSelectedAdvancedFilter()   X-Ref
Function returns Reports Advanced Filters

return: type

save()   X-Ref
Function saves a Report


saveSortFields()   X-Ref
Function saves Reports Sorting Fields


saveCalculationFields()   X-Ref
Function saves Reports Calculation Fields information


saveStandardFilter()   X-Ref
Function saves Reports Standard Filter information


saveSharingInformation()   X-Ref
Function saves Reports Sharing information


saveSelectedFields()   X-Ref
Functions saves Reports selected fields


saveAdvancedFilters()   X-Ref
Function saves Reports Filter information


saveScheduleInformation()   X-Ref
Function saves Reports Scheduling information


deleteScheduling()   X-Ref
Function deletes report scheduling information


getReportSQL($advancedFilterSQL=false, $format=false)   X-Ref
Function returns sql for the report

param: <String> $advancedFilterSQL
param: <String> $format
return: <String>

generateCountQuery($query)   X-Ref
Function returns sql for count query which don't need any fields

param: <String> $query (with all columns)
return: <String> $query (by removing all columns)

getReportData($pagingModel = false, $filterQuery = false)   X-Ref
Function returns report's data

param: <Vtiger_Paging_Model> $pagingModel
param: <String> $filterQuery
return: <Array>

getReportsCount($query = null)   X-Ref
No description

getReportCalulationData($filterQuery = false)   X-Ref
No description

getReportXLS()   X-Ref
Function exports reports data into a Excel file


getReportCSV()   X-Ref
Function exports reports data into a csv file


getReportPrint()   X-Ref
Function returns data in printable format

return: <Array>

isDefault()   X-Ref
Function returns reports is default or not

return: <boolean>

move($folderId)   X-Ref
Function move report to another specified folder

param: folderid

getPrimaryModuleCalculationFields()   X-Ref
Function to get Calculation fields for Primary module

return: <Array> Primary module calculation fields

getSecondaryModuleCalculationFields()   X-Ref
Function to get Calculation fields for Secondary modules

return: <Array> Secondary modules calculation fields

getCalculationFields()   X-Ref
Function to get Calculation fields for entire Report

return: <Array> report calculation fields

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

getAdvancedFilterSQL()   X-Ref
Function returns the Advanced filter SQL

return: <String>

generateData($pagingModel = false)   X-Ref
Function to generate data for advanced filter conditions

param: Vtiger_Paging_Model $pagingModel
return: <Array>

generateCalculationData()   X-Ref
Function to generate data for advanced filter conditions

param: Vtiger_Paging_Model $pagingModel
return: <Array>

checkDuplicate()   X-Ref
Function to check duplicate exists or not

return: <boolean>

showLineItemFieldsInFilter($calculationFields=false)   X-Ref
Function is used for Inventory reports, filters should show line items fields only if they are selected in
calculation otherwise it should not be shown

return: boolean

getScheduledReport()   X-Ref
No description

getRecordsListFromRequest(Vtiger_Request $request)   X-Ref
No description

getModuleCalculationFieldsForReport()   X-Ref
No description

getAggregateFunctions()   X-Ref
No description

saveReportType()   X-Ref
Function to save reprot tyep data


getReportTypeInfo()   X-Ref
No description

getPrimaryModuleFieldsForAdvancedReporting()   X-Ref
Function is used in Charts to remove fields like email, phone, descriptions etc
as these fields are not generally used for grouping records

return: $fields - array of report field columns

getSecondaryModuleFieldsForAdvancedReporting()   X-Ref
Function is used in Charts to remove fields like email, phone, descriptions etc
as these fields are not generally used for grouping records

return: $fields - array of report field columns



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