TimeTrex API Manual
Back to top  

package Modules\Report
inherited_from \Report

 Methods

Total() 

Total() 
Inherited

__construct() 

__construct() 
inherited_from \Report::__construct()

__construct() 

__construct() 
Inherited

_getData() 

_getData($format = NULL) 

Parameters

$format

_html() 

_html() 
Inherited

_html_CSS() 

_html_CSS() 
Inherited

_html_Chart() 

_html_Chart() 
Inherited

_html_Footer() 

_html_Footer() 
Inherited

_html_Header() 

_html_Header() 
Inherited

_html_Initialize() 

_html_Initialize() 
Inherited

_html_Table() 

_html_Table() 
Inherited

_html_TopSummary() 

_html_TopSummary() 
Inherited

_html_checkMaximumPageLimit() 

_html_checkMaximumPageLimit($cur) 
Inherited

Parameters

$cur

_html_fontSize() 

_html_fontSize($size) 
Inherited

Parameters

$size

_html_setPageOrientationCSS() 

_html_setPageOrientationCSS() 
Inherited

_output() 

_output($format = NULL) 
inherited_from \Report::_output()

Parameters

$format

_output() 

_output($format = NULL) 
Inherited

Parameters

$format

_outputPDFSchedule() 

_outputPDFSchedule($format) 

Parameters

$format

_pdf() 

_pdf() 
Inherited

_pdf_AddPage() 

_pdf_AddPage() 
Inherited

_pdf_Chart() 

_pdf_Chart() 
Inherited

_pdf_Footer() 

_pdf_Footer() 
Inherited

_pdf_Header() 

_pdf_Header() 
Inherited

_pdf_Initialize() 

_pdf_Initialize() 
Inherited

_pdf_Table() 

_pdf_Table() 
Inherited

_pdf_TopSummary() 

_pdf_TopSummary() 
Inherited

_pdf_checkMaximumPageLimit() 

_pdf_checkMaximumPageLimit() 
Inherited

_pdf_checkPageBreak() 

_pdf_checkPageBreak($height, $add_page = TRUE) 
Inherited

Parameters

$height

$add_page

_pdf_detectPageSize() 

_pdf_detectPageSize($column_options, $columns) 
Inherited

Parameters

$column_options

$columns

_pdf_displayMaximumPageLimitError() 

_pdf_displayMaximumPageLimitError() 
Inherited

_pdf_drawLine() 

_pdf_drawLine($width = 3) 
Inherited

Parameters

$width

_pdf_fontSize() 

_pdf_fontSize($size) 
Inherited

Parameters

$size

_pdf_getColumnHeight() 

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

Parameters

$text

$layout

$wrap_width

_pdf_getColumnWidth() 

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

Parameters

$text

$layout

$wrap_width

_pdf_getLargestWrappedWord() 

_pdf_getLargestWrappedWord($string, $width, $layout) 
Inherited

Parameters

$string

$width

$layout

_pdf_getMaximumHeightFromArray() 

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

Parameters

$columns

$column_options

$column_widths

$wrap_width

$min_height

_pdf_getPageSizeDimensionsFromWidth() 

_pdf_getPageSizeDimensionsFromWidth($min_width) 
Inherited

Parameters

$min_width

_pdf_getTableColumnWidths() 

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

Parameters

$columns

$layout

$fill_page

$wrap_width

_pdf_scaleSize() 

_pdf_scaleSize($size) 
Inherited

Parameters

$size

_pdf_unitsToPixels() 

_pdf_unitsToPixels($size) 
Inherited

Parameters

$size

_postOutput() 

_postOutput($format = NULL) 
Inherited

Parameters

$format

_postProcess() 

_postProcess($format = NULL) 
Inherited

Parameters

$format

_preOutput() 

_preOutput($format = NULL) 
Inherited

Parameters

$format

_preProcess() 

_preProcess() 

calculateCustomColumnFilters() 

calculateCustomColumnFilters($type_id) 
Inherited

Parameters

$type_id

calculateCustomColumns() 

calculateCustomColumns($type_id) 
Inherited

Parameters

$type_id

chart() 

chart() 
Inherited

checkPermissions() 

checkPermissions() 
Inherited

columnFormatter() 

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

Parameters

$type

$column

$value

$format

convertArrayNumericKeysToString() 

convertArrayNumericKeysToString($arr) 
Inherited

Parameters

$arr

convertTimePeriodToStartEndDate() 

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

Parameters

$time_period_arr

$prefix

$force_dates_for_pay_periods

currencyConvertToBase() 

currencyConvertToBase() 
Inherited

downloadOutput() 

downloadOutput() 
Inherited

email() 

email($output, $report_schedule_obj = NULL) 
Inherited

Parameters

$output

$report_schedule_obj

emailOutput() 

emailOutput() 
Inherited

formatGroupConfig() 

formatGroupConfig() 
Inherited

formatSubTotalConfig() 

formatSubTotalConfig() 
Inherited

getAMFMessageID() 

getAMFMessageID() 
Inherited

getBaseCurrencyObject() 

getBaseCurrencyObject() 
Inherited

getChartConfig() 

getChartConfig() 
Inherited

getColumnConfig() 

getColumnConfig() 
Inherited

getColumnDataConfig() 

getColumnDataConfig() 
Inherited

getColumnFormatConfig() 

getColumnFormatConfig() 
Inherited

getCompanyFormConfig() 

getCompanyFormConfig() 
Inherited

getConfig() 

getConfig() 
Inherited

getCurrencyConvertToBase() 

getCurrencyConvertToBase() 
Inherited

getCurrencyObject() 

getCurrencyObject() 
Inherited

getCustomColumnConfig() 

getCustomColumnConfig() 
Inherited

getCustomColumnFormatOptions() 

getCustomColumnFormatOptions($format_options = array()) 
Inherited

Parameters

$format_options

getCustomFilterConfig() 

getCustomFilterConfig() 
Inherited

getData() 

getData($format) 
Inherited

Parameters

$format

getDescription() 

getDescription($label, $params = NULL) 
Inherited

Parameters

$label

$params

getDescriptionBlock() 

getDescriptionBlock($html = FALSE, $relative_time_period = FALSE) 
Inherited

Parameters

$html

$relative_time_period

getFileMimeType() 

getFileMimeType() 
Inherited

getFileName() 

getFileName() 
Inherited

getFilterConfig() 

getFilterConfig() 
Inherited

getFormConfig() 

getFormConfig() 
Inherited

getGroupConfig() 

getGroupConfig() 
Inherited

getLargestColumnData() 

getLargestColumnData($columns, $include_headers = TRUE) 
Inherited

Parameters

$columns

$include_headers

getOptions() 

getOptions($name, $params = NULL) 
Inherited

Parameters

$name

$params

getOtherConfig() 

getOtherConfig() 
Inherited

getOutput() 

getOutput($format = NULL) 
Inherited

Parameters

$format

getPermissionObject() 

getPermissionObject() 
Inherited

getProgressBarObject() 

getProgressBarObject() 
Inherited

getReportColumns() 

getReportColumns($num = FALSE) 
Inherited

Parameters

$num

getSortConfig() 

getSortConfig() 
Inherited

getSubTotalColumnLabelPosition() 

getSubTotalColumnLabelPosition($row, $columns, $sub_total_columns) 
Inherited

Parameters

$row

$columns

$sub_total_columns

getSubTotalConfig() 

getSubTotalConfig() 
Inherited

getTable() 

getTable() 
Inherited

getTemplate() 

getTemplate($name) 
Inherited

Parameters

$name

getTimePeriodFormatOptions() 

getTimePeriodFormatOptions($format_options = array()) 
Inherited

Parameters

$format_options

getUserObject() 

getUserObject() 
Inherited

group() 

group() 
Inherited

handleReportCurrency() 

handleReportCurrency($currency_convert_to_base, $base_currency_obj, $filter_data) 
Inherited

Parameters

$currency_convert_to_base

$base_currency_obj

$filter_data

hasData() 

hasData() 
Inherited

isEnabledChart() 

isEnabledChart() 
Inherited

isSystemLoadValid() 

isSystemLoadValid() 
Inherited

loadTemplate() 

loadTemplate($name) 
Inherited

Parameters

$name

postProcess() 

postProcess($format = NULL) 
Inherited

Parameters

$format

preProcess() 

preProcess($format = NULL) 
Inherited

Parameters

$format

scheduleAddPage() 

scheduleAddPage() 

scheduleCheckPageBreak() 

scheduleCheckPageBreak($height, $add_page = TRUE) 

Parameters

$height

$add_page

scheduleDayOfWeekNameHeader() 

scheduleDayOfWeekNameHeader($start_week_day, $column_widths, $format) 

Parameters

$start_week_day

$column_widths

$format

scheduleFooter() 

scheduleFooter() 

scheduleFooterWeek() 

scheduleFooterWeek() 

scheduleHeader() 

scheduleHeader($branch = NULL, $department = NULL, $job = NULL, $job_item = NULL, $user = NULL, $new_page = TRUE) 

Parameters

$branch

$department

$job

$job_item

$user

$new_page

scheduleNoData() 

scheduleNoData() 

scheduleUserWeek() 

scheduleUserWeek($schedule_data, $calendar_array, $start_week_day, $column_widths, $format, $row = 0) 

Parameters

$schedule_data

$calendar_array

$start_week_day

$column_widths

$format

$row

scheduleWeekHeader() 

scheduleWeekHeader($calendar_array, $column_widths, $format, $new_page = FALSE) 

Parameters

$calendar_array

$column_widths

$format

$new_page

setAMFMessageID() 

setAMFMessageID($id) 
Inherited

Parameters

$id

setChartConfig() 

setChartConfig($data) 
Inherited

Parameters

$data

setColumnConfig() 

setColumnConfig($data) 
Inherited

Parameters

$data

setColumnDataConfig() 

setColumnDataConfig($data) 
Inherited

Parameters

$data

setCompanyFormConfig() 

setCompanyFormConfig($data = NULL) 
Inherited

Parameters

$data

setConfig() 

setConfig($data) 
Inherited

Parameters

$data

setCurrencyObject() 

setCurrencyObject($obj) 
Inherited

Parameters

$obj

setCustomColumnConfig() 

setCustomColumnConfig($columns) 
Inherited

Parameters

$columns

setCustomFilterConfig() 

setCustomFilterConfig($data) 
Inherited

Parameters

$data

setExecutionMemoryLimit() 

setExecutionMemoryLimit($str = FALSE) 
Inherited

Parameters

$str

setExecutionTimeLimit() 

setExecutionTimeLimit($int = FALSE) 
Inherited

Parameters

$int

setFilterConfig() 

setFilterConfig($data) 
Inherited

Parameters

$data

setFormConfig() 

setFormConfig($data) 
Inherited

Parameters

$data

setGroupConfig() 

setGroupConfig($data) 
Inherited

Parameters

$data

setOtherConfig() 

setOtherConfig($data) 
Inherited

Parameters

$data

setPermissionObject() 

setPermissionObject($obj) 
Inherited

Parameters

$obj

setQueryStatementTimeout() 

setQueryStatementTimeout($milliseconds = NULL) 
Inherited

Parameters

$milliseconds

setSortConfig() 

setSortConfig($data) 
Inherited

Parameters

$data

setSubTotalConfig() 

setSubTotalConfig($data) 
Inherited

Parameters

$data

setUserObject() 

setUserObject($obj) 
Inherited

Parameters

$obj

sort() 

sort() 
Inherited

sortFormData() 

sortFormData() 
Inherited

subTotal() 

subTotal() 
Inherited

validateConfig() 

validateConfig($format = FALSE) 
Inherited

Parameters

$format

__getOptions() 

__getOptions($name, $params = NULL) 
Inherited

Parameters

$name

$params

_checkPermissions() 

_checkPermissions($user_id, $company_id) 

Parameters

$user_id

$company_id

_getOptions() 

_getOptions($name, $params = NULL) 
inherited_from \Report::_getOptions()

Parameters

$name

$params

_getOptions() 

_getOptions($name, $params = NULL) 
Inherited

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
 

$special_output_format

$special_output_format 

Default

array('pdf_schedule_group_combined', 'pdf_schedule_group_combined_print', 'pdf_schedule_group', 'pdf_schedule_group_print', 'pdf_schedule_group_pagebreak', 'pdf_schedule_group_pagebreak_print', 'pdf_schedule', 'pdf_schedule_print')
 

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