package Modules\Report

 Methods

Total()

Total() 

__construct()

__construct() 

_html()

_html() 

_html_CSS()

_html_CSS() 

_html_Chart()

_html_Chart() 

_html_Header()

_html_Header() 

_html_Initialize()

_html_Initialize() 

_html_Table()

_html_Table() 

_html_TopSummary()

_html_TopSummary() 

_html_checkMaximumPageLimit()

_html_checkMaximumPageLimit($cur) 

Parameters

$cur

_html_fontSize()

_html_fontSize($size) 

Parameters

$size

_html_setPageOrientationCSS()

_html_setPageOrientationCSS() 

_output()

_output($format = NULL

Parameters

$format

_pdf()

_pdf() 

_pdf_AddPage()

_pdf_AddPage() 

_pdf_Chart()

_pdf_Chart() 

_pdf_Header()

_pdf_Header() 

_pdf_Initialize()

_pdf_Initialize() 

_pdf_Table()

_pdf_Table() 

_pdf_TopSummary()

_pdf_TopSummary() 

_pdf_checkMaximumPageLimit()

_pdf_checkMaximumPageLimit() 

_pdf_checkPageBreak()

_pdf_checkPageBreak($height, $add_page = TRUE

Parameters

$height

$add_page

_pdf_detectPageSize()

_pdf_detectPageSize($column_options, $columns) 

Parameters

$column_options

$columns

_pdf_displayMaximumPageLimitError()

_pdf_displayMaximumPageLimitError() 

_pdf_drawLine()

_pdf_drawLine($width = 3

Parameters

$width

_pdf_fontSize()

_pdf_fontSize($size) 

Parameters

$size

_pdf_getColumnHeight()

_pdf_getColumnHeight($text, $layout, $wrap_width = FALSE

Parameters

$text

$layout

$wrap_width

_pdf_getColumnWidth()

_pdf_getColumnWidth($text, $layout, $wrap_width = FALSE

Parameters

$text

$layout

$wrap_width

_pdf_getLargestWrappedWord()

_pdf_getLargestWrappedWord($string, $width, $layout) 

Parameters

$string

$width

$layout

_pdf_getMaximumHeightFromArray()

_pdf_getMaximumHeightFromArray($columns, $column_options, $column_widths, $wrap_width, $min_height = 0

Parameters

$columns

$column_options

$column_widths

$wrap_width

$min_height

_pdf_getPageSizeDimensionsFromWidth()

_pdf_getPageSizeDimensionsFromWidth($min_width) 

Parameters

$min_width

_pdf_getTableColumnWidths()

_pdf_getTableColumnWidths($columns, $layout, $fill_page = TRUE, $wrap_width = FALSE

Parameters

$columns

$layout

$fill_page

$wrap_width

_pdf_scaleSize()

_pdf_scaleSize($size) 

Parameters

$size

_pdf_unitsToPixels()

_pdf_unitsToPixels($size) 

Parameters

$size

_postOutput()

_postOutput($format = NULL

Parameters

$format

_postProcess()

_postProcess($format = NULL

Parameters

$format

_preOutput()

_preOutput($format = NULL

Parameters

$format

calculateCustomColumnFilters()

calculateCustomColumnFilters($type_id) 

Parameters

$type_id

calculateCustomColumns()

calculateCustomColumns($type_id) 

Parameters

$type_id

chart()

chart() 

checkPermissions()

checkPermissions() 

columnFormatter()

columnFormatter($type, $column, $value, $format = NULL

Parameters

$type

$column

$value

$format

convertArrayNumericKeysToString()

convertArrayNumericKeysToString($arr) 

Parameters

$arr

convertTimePeriodToStartEndDate()

convertTimePeriodToStartEndDate($time_period_arr, $prefix = NULL, $force_dates_for_pay_periods = FALSE

Parameters

$time_period_arr

$prefix

$force_dates_for_pay_periods

currencyConvertToBase()

currencyConvertToBase() 

downloadOutput()

downloadOutput() 

email()

email($output, $report_schedule_obj = NULL

Parameters

$output

$report_schedule_obj

emailOutput()

emailOutput() 

formatGroupConfig()

formatGroupConfig() 

formatSubTotalConfig()

formatSubTotalConfig() 

getAMFMessageID()

getAMFMessageID() 

getBaseCurrencyObject()

getBaseCurrencyObject() 

getChartConfig()

getChartConfig() 

getColumnConfig()

getColumnConfig() 

getColumnDataConfig()

getColumnDataConfig() 

getColumnFormatConfig()

getColumnFormatConfig() 

getCompanyFormConfig()

getCompanyFormConfig() 

getConfig()

getConfig() 

getCurrencyConvertToBase()

getCurrencyConvertToBase() 

getCurrencyObject()

getCurrencyObject() 

getCustomColumnConfig()

getCustomColumnConfig() 

getCustomColumnFormatOptions()

getCustomColumnFormatOptions($format_options = array()

Parameters

$format_options

getCustomFilterConfig()

getCustomFilterConfig() 

getData()

getData($format) 

Parameters

$format

getDescription()

getDescription($label, $params = NULL

Parameters

$label

$params

getDescriptionBlock()

getDescriptionBlock($html = FALSE, $relative_time_period = FALSE

Parameters

$html

$relative_time_period

getFileMimeType()

getFileMimeType() 

getFileName()

getFileName() 

getFilterConfig()

getFilterConfig() 

getFormConfig()

getFormConfig() 

getGroupConfig()

getGroupConfig() 

getLargestColumnData()

getLargestColumnData($columns, $include_headers = TRUE

Parameters

$columns

$include_headers

getOptions()

getOptions($name, $params = NULL

Parameters

$name

$params

getOtherConfig()

getOtherConfig() 

getOutput()

getOutput($format = NULL

Parameters

$format

getPermissionObject()

getPermissionObject() 

getProgressBarObject()

getProgressBarObject() 

getReportColumns()

getReportColumns($num = FALSE

Parameters

$num

getSortConfig()

getSortConfig() 

getSubTotalColumnLabelPosition()

getSubTotalColumnLabelPosition($row, $columns, $sub_total_columns) 

Parameters

$row

$columns

$sub_total_columns

getSubTotalConfig()

getSubTotalConfig() 

getTable()

getTable() 

getTemplate()

getTemplate($name) 

Parameters

$name

getTimePeriodFormatOptions()

getTimePeriodFormatOptions($format_options = array()

Parameters

$format_options

getUserObject()

getUserObject() 

group()

group() 

handleReportCurrency()

handleReportCurrency($currency_convert_to_base, $base_currency_obj, $filter_data) 

Parameters

$currency_convert_to_base

$base_currency_obj

$filter_data

hasData()

hasData() 

isEnabledChart()

isEnabledChart() 

isSystemLoadValid()

isSystemLoadValid() 

loadTemplate()

loadTemplate($name) 

Parameters

$name

postProcess()

postProcess($format = NULL

Parameters

$format

preProcess()

preProcess($format = NULL

Parameters

$format

setAMFMessageID()

setAMFMessageID($id) 

Parameters

$id

setChartConfig()

setChartConfig($data) 

Parameters

$data

setColumnConfig()

setColumnConfig($data) 

Parameters

$data

setColumnDataConfig()

setColumnDataConfig($data) 

Parameters

$data

setCompanyFormConfig()

setCompanyFormConfig($data = NULL

Parameters

$data

setConfig()

setConfig($data) 

Parameters

$data

setCurrencyObject()

setCurrencyObject($obj) 

Parameters

$obj

setCustomColumnConfig()

setCustomColumnConfig($columns) 

Parameters

$columns

setCustomFilterConfig()

setCustomFilterConfig($data) 

Parameters

$data

setExecutionMemoryLimit()

setExecutionMemoryLimit($str = FALSE

Parameters

$str

setExecutionTimeLimit()

setExecutionTimeLimit($int = FALSE

Parameters

$int

setFilterConfig()

setFilterConfig($data) 

Parameters

$data

setFormConfig()

setFormConfig($data) 

Parameters

$data

setGroupConfig()

setGroupConfig($data) 

Parameters

$data

setOtherConfig()

setOtherConfig($data) 

Parameters

$data

setPermissionObject()

setPermissionObject($obj) 

Parameters

$obj

setQueryStatementTimeout()

setQueryStatementTimeout($milliseconds = NULL

Parameters

$milliseconds

setSortConfig()

setSortConfig($data) 

Parameters

$data

setSubTotalConfig()

setSubTotalConfig($data) 

Parameters

$data

setUserObject()

setUserObject($obj) 

Parameters

$obj

sort()

sort() 

sortFormData()

sortFormData() 

subTotal()

subTotal() 

validateConfig()

validateConfig($format = FALSE

Parameters

$format

__getOptions()

__getOptions($name, $params = NULL

Parameters

$name

$params

_getOptions()

_getOptions($name, $params = NULL

Parameters

$name

$params

 Properties

 

$currency_obj

$currency_obj 

Default

NULL
 

$data

$data 

Default

NULL
 

$file_mime_type

$file_mime_type 

Default

'application/pdf'
 

$file_name

$file_name 

Default

'report'
 

$html

$html 

Default

NULL
 

$pdf

$pdf 

Default

NULL
 

$permission_obj

$permission_obj 

Default

NULL
 

$title

$title 

Default

NULL
 

$user_obj

$user_obj 

Default

NULL
 

$validator

$validator 

Default

NULL
 

$AMF_message_id

$AMF_message_id 

Default

NULL
 

$PDF_IMAGE_SCALE_RATIO

$PDF_IMAGE_SCALE_RATIO 

Default

1.25
 

$chart_images

$chart_images 

Default

array()
 

$config

$config 

Default

array('other' => array('report_name' => '', 'is_embedded' => FALSE, 'disable_grand_total' => FALSE, 'page_orientation' => 'P', 'page_format' => 'LETTER', 'default_font' => '', 'maximum_page_limit' => 100, 'maximum_row_limit' => FALSE, 'query_statement_timeout' => 600000, 'maximum_memory_limit' => '1024M', 'maximum_execution_limit' => 1800, 'font_size' => 0, 'table_header_font_size' => 8, 'table_row_font_size' => 8, 'table_header_word_wrap' => 10, 'table_data_word_wrap' => 50, 'top_margin' => 5, 'bottom_margin' => 5, 'left_margin' => 5, 'right_margin' => 5, 'adjust_horizontal_position' => 0, 'adjust_vertical_position' => 0, 'show_blank_values' => TRUE, 'blank_value_placeholder' => '-', 'show_duplicate_values' => FALSE, 'duplicate_value_placeholder' => ' ', 'auto_refresh' => FALSE), 'chart' => array('enable' => FALSE, 'type' => 10, 'display_mode' => 10, 'point_labels' => TRUE, 'include_sub_total' => FALSE, 'axis_scale_min' => FALSE, 'axis_scale_static' => FALSE, 'combine_columns' => TRUE))
 

$data_column_widths

$data_column_widths 

Default

NULL
 

$form_data

$form_data 

Default

NULL
 

$form_obj

$form_obj 

Default

NULL
 

$maximum_memory_limit

$maximum_memory_limit 

Default

FALSE
 

$profiler

$profiler 

Default

NULL
 

$progress_bar_obj

$progress_bar_obj 

Default

NULL
 

$tmp_data

$tmp_data 

Default

NULL
 

$total_row

$total_row 

Default

NULL
 

$option_cache

$option_cache 

Default

array()