Skip to content

Report

Jump to bottom
Aydan Coskun edited this page Nov 29, 2019 · 1 revision

Report

  • Class name: Report
  • Namespace:

Properties

$title

public mixed $title = NULL
  • Visibility: public

$file_name

public mixed $file_name = 'report'
  • Visibility: public

$file_mime_type

public mixed $file_mime_type = 'application/pdf'
  • Visibility: public

$PDF_IMAGE_SCALE_RATIO

protected mixed $PDF_IMAGE_SCALE_RATIO = 1.25
  • Visibility: protected

$config

protected mixed $config = 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' => '3072M', '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))
  • Visibility: protected

$duplicate_value_ignored_columns

public mixed $duplicate_value_ignored_columns = array('first_name' => TRUE, 'last_name' => TRUE, 'verified_time_sheet' => TRUE, 'verified_time_sheet_date' => TRUE, 'date_stamp' => TRUE, 'start_date' => TRUE, 'end_date' => TRUE, 'start_time' => TRUE, 'end_time' => TRUE)
  • Visibility: public

$maximum_memory_limit

protected mixed $maximum_memory_limit = FALSE
  • Visibility: protected

$tmp_data

protected mixed $tmp_data = NULL
  • Visibility: protected

$data

public mixed $data = NULL
  • Visibility: public

$total_row

protected mixed $total_row = NULL
  • Visibility: protected

$data_column_widths

protected mixed $data_column_widths = NULL
  • Visibility: protected

$pdf

public mixed $pdf = NULL
  • Visibility: public

$html

public mixed $html = NULL
  • Visibility: public

$option_cache

private mixed $option_cache = array()
  • Visibility: private

$chart_images

protected mixed $chart_images = array()
  • Visibility: protected

$form_obj

protected mixed $form_obj = NULL
  • Visibility: protected

$form_data

protected mixed $form_data = NULL
  • Visibility: protected

$profiler

protected mixed $profiler = NULL
  • Visibility: protected

$user_obj

public mixed $user_obj = NULL
  • Visibility: public

$permission_obj

public mixed $permission_obj = NULL
  • Visibility: public

$currency_obj

public mixed $currency_obj = NULL
  • Visibility: public

$validator

public mixed $validator = NULL
  • Visibility: public

$progress_bar_obj

protected mixed $progress_bar_obj = NULL
  • Visibility: protected

$AMF_message_id

protected mixed $AMF_message_id = NULL
  • Visibility: protected

$enable_system_columns

protected mixed $enable_system_columns = FALSE
  • Visibility: protected

Methods

__getOptions

array|null Report::__getOptions($name, null $params)
  • Visibility: protected

Arguments

  • $name mixed
  • $params null

__construct

mixed Report::__construct()

Report constructor.

  • Visibility: public

setEnableSystemColumns

boolean Report::setEnableSystemColumns($bool)

When this is enabled, it ignores checking that the columns returned are actually in the list of available columns.

Useful for when we need reports to return IDs and such, like when sending AgencyReprots to PaymentServices.

  • Visibility: public

Arguments

  • $bool mixed

getEnableSystemColumns

boolean Report::getEnableSystemColumns()
  • Visibility: public

setExecutionTimeLimit

boolean Report::setExecutionTimeLimit(boolean $int)
  • Visibility: public

Arguments

  • $int boolean

setExecutionMemoryLimit

boolean Report::setExecutionMemoryLimit(boolean $str)
  • Visibility: public

Arguments

  • $str boolean

isSystemLoadValid

boolean Report::isSystemLoadValid()
  • Visibility: public

setUserObject

boolean Report::setUserObject(object $obj)
  • Visibility: public

Arguments

  • $obj object

getUserObject

null Report::getUserObject()
  • Visibility: public

setPermissionObject

boolean Report::setPermissionObject(object $obj)
  • Visibility: public

Arguments

  • $obj object

getPermissionObject

null Report::getPermissionObject()
  • Visibility: public

getCurrencyConvertToBase

boolean Report::getCurrencyConvertToBase()

Object of the currency used in the report, we use this to base currency column formats on.

  • Visibility: public

getBaseCurrencyObject

boolean|object Report::getBaseCurrencyObject()
  • Visibility: public

handleReportCurrency

boolean Report::handleReportCurrency($currency_convert_to_base, object $base_currency_obj, $filter_data)
  • Visibility: public

Arguments

  • $currency_convert_to_base mixed
  • $base_currency_obj object
  • $filter_data mixed

setCurrencyObject

boolean Report::setCurrencyObject(object $obj)
  • Visibility: public

Arguments

  • $obj object

getCurrencyObject

null Report::getCurrencyObject()
  • Visibility: public

getTable

string Report::getTable()
  • Visibility: public

getProgressBarObject

null|\ProgressBar Report::getProgressBarObject()
  • Visibility: public

getAMFMessageID

boolean|null Report::getAMFMessageID()
  • Visibility: public

setAMFMessageID

boolean Report::setAMFMessageID(string $id)
  • Visibility: public

Arguments

  • $id string - UUID

setConfig

boolean Report::setConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getConfig

array Report::getConfig()
  • Visibility: public

getTemplate

boolean|mixed Report::getTemplate($name)
  • Visibility: public

Arguments

  • $name mixed

loadTemplate

boolean Report::loadTemplate($name)
  • Visibility: public

Arguments

  • $name mixed

setColumnConfig

boolean Report::setColumnConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getColumnConfig

boolean|mixed Report::getColumnConfig()
  • Visibility: public

setColumnDataConfig

boolean Report::setColumnDataConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getColumnDataConfig

boolean|mixed Report::getColumnDataConfig()
  • Visibility: public

convertTimePeriodToStartEndDate

array|boolean Report::convertTimePeriodToStartEndDate($time_period_arr, null $prefix, boolean $force_dates_for_pay_periods)
  • Visibility: public

Arguments

  • $time_period_arr mixed
  • $prefix null
  • $force_dates_for_pay_periods boolean

setFilterConfig

boolean Report::setFilterConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getFilterConfig

boolean|mixed Report::getFilterConfig()
  • Visibility: public

convertArrayNumericKeysToString

array|boolean Report::convertArrayNumericKeysToString($arr)
  • Visibility: public

Arguments

  • $arr mixed

formatGroupConfig

array|boolean Report::formatGroupConfig()
  • Visibility: public

setGroupConfig

boolean Report::setGroupConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getGroupConfig

boolean|mixed Report::getGroupConfig()
  • Visibility: public

getReportColumns

boolean|mixed Report::getReportColumns(boolean $num)
  • Visibility: public

Arguments

  • $num boolean

formatSubTotalConfig

array|boolean Report::formatSubTotalConfig()
  • Visibility: public

setSubTotalConfig

boolean Report::setSubTotalConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getSubTotalConfig

boolean|mixed Report::getSubTotalConfig()
  • Visibility: public

setSortConfig

boolean Report::setSortConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getSortConfig

boolean|mixed Report::getSortConfig()
  • Visibility: public

setCompanyFormConfig

boolean Report::setCompanyFormConfig(null $data)
  • Visibility: public

Arguments

  • $data null

getCompanyFormConfig

boolean Report::getCompanyFormConfig()
  • Visibility: public

setFormConfig

boolean Report::setFormConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getFormConfig

boolean|mixed Report::getFormConfig()
  • Visibility: public

setOtherConfig

boolean Report::setOtherConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getOtherConfig

boolean|mixed Report::getOtherConfig()
  • Visibility: public

isEnabledChart

boolean Report::isEnabledChart()
  • Visibility: public

setChartConfig

boolean Report::setChartConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getChartConfig

boolean|mixed Report::getChartConfig()
  • Visibility: public

setCustomFilterConfig

boolean Report::setCustomFilterConfig($data)
  • Visibility: public

Arguments

  • $data mixed

getCustomFilterConfig

boolean|mixed Report::getCustomFilterConfig()
  • Visibility: public

validateConfig

null|\Validator Report::validateConfig(boolean $format)
  • Visibility: public

Arguments

  • $format boolean

getFileName

string Report::getFileName()
  • Visibility: public

getFileMimeType

string Report::getFileMimeType()
  • Visibility: public

getOptions

boolean|mixed Report::getOptions($name, null $params)
  • Visibility: public

Arguments

  • $name mixed
  • $params null

_getOptions

boolean Report::_getOptions($name, null $params)
  • Visibility: protected

Arguments

  • $name mixed
  • $params null

getData

boolean Report::getData($format)
  • Visibility: public

Arguments

  • $format mixed

preProcess

boolean Report::preProcess(null $format)
  • Visibility: public

Arguments

  • $format null

group

boolean Report::group()
  • Visibility: public

sort

boolean Report::sort()
  • Visibility: public

sortFormData

boolean Report::sortFormData()
  • Visibility: public

Total

boolean Report::Total()
  • Visibility: public

subTotal

boolean Report::subTotal()
  • Visibility: public

chart

boolean Report::chart()
  • Visibility: public

postProcess

boolean Report::postProcess(null $format)
  • Visibility: public

Arguments

  • $format null

columnFormatter

array|boolean|false|mixed|null|string Report::columnFormatter($type, $column, $value, null $format)
  • Visibility: public

Arguments

  • $type mixed
  • $column mixed
  • $value mixed
  • $format null

getTimePeriodFormatOptions

array Report::getTimePeriodFormatOptions(array $format_options)
  • Visibility: public

Arguments

  • $format_options array

getCustomColumnFormatOptions

array Report::getCustomColumnFormatOptions(array $format_options)
  • Visibility: public

Arguments

  • $format_options array

currencyConvertToBase

boolean Report::currencyConvertToBase()
  • Visibility: public

getColumnFormatConfig

array Report::getColumnFormatConfig()
  • Visibility: public

_postProcess

boolean Report::_postProcess(null $format)
  • Visibility: public

Arguments

  • $format null

getDescriptionBlock

string Report::getDescriptionBlock(boolean $html, boolean $relative_time_period)
  • Visibility: public

Arguments

  • $html boolean
  • $relative_time_period boolean

getDescription

boolean|string Report::getDescription($label, null $params)
  • Visibility: public

Arguments

  • $label mixed
  • $params null

checkPermissions

boolean Report::checkPermissions()
  • Visibility: public

setQueryStatementTimeout

boolean Report::setQueryStatementTimeout(null $milliseconds)
  • Visibility: public

Arguments

  • $milliseconds null

getOutput

array|boolean Report::getOutput(null $format)
  • Visibility: public

Arguments

  • $format null

_preOutput

boolean Report::_preOutput(null $format)
  • Visibility: public

Arguments

  • $format null

_output

array|boolean Report::_output(null $format)
  • Visibility: public

Arguments

  • $format null

_postOutput

boolean Report::_postOutput(null $format)
  • Visibility: public

Arguments

  • $format null

hasData

boolean Report::hasData()
  • Visibility: public

email

boolean Report::email($output, object $report_schedule_obj)
  • Visibility: public

Arguments

  • $output mixed
  • $report_schedule_obj object

_pdf_detectPageSize

array Report::_pdf_detectPageSize($column_options, $columns)
  • Visibility: public

Arguments

  • $column_options mixed
  • $columns mixed

getLargestColumnData

array Report::getLargestColumnData($columns, boolean $include_headers)
  • Visibility: public

Arguments

  • $columns mixed
  • $include_headers boolean

_pdf_getColumnWidth

float|integer Report::_pdf_getColumnWidth($text, $layout, boolean $wrap_width)
  • Visibility: public

Arguments

  • $text mixed
  • $layout mixed
  • $wrap_width boolean

_pdf_getColumnHeight

float|integer Report::_pdf_getColumnHeight($text, $layout, boolean $wrap_width)
  • Visibility: public

Arguments

  • $text mixed
  • $layout mixed
  • $wrap_width boolean

_pdf_getLargestWrappedWord

null Report::_pdf_getLargestWrappedWord($string, string $width, $layout)
  • Visibility: public

Arguments

  • $string mixed
  • $width string - UUID
  • $layout mixed

_pdf_getTableColumnWidths

array|boolean Report::_pdf_getTableColumnWidths($columns, $layout, boolean $fill_page, boolean $wrap_width)
  • Visibility: public

Arguments

  • $columns mixed
  • $layout mixed
  • $fill_page boolean
  • $wrap_width boolean

_pdf_unitsToPixels

mixed Report::_pdf_unitsToPixels($size)
  • Visibility: public

Arguments

  • $size mixed

_pdf_scaleSize

float Report::_pdf_scaleSize($size)
  • Visibility: public

Arguments

  • $size mixed

_pdf_fontSize

float Report::_pdf_fontSize($size)
  • Visibility: public

Arguments

  • $size mixed

_html_fontSize

float Report::_html_fontSize($size)
  • Visibility: public

Arguments

  • $size mixed

_pdf_getPageSizeDimensionsFromWidth

array Report::_pdf_getPageSizeDimensionsFromWidth(string $min_width)
  • Visibility: public

Arguments

  • $min_width string - UUID

_pdf_drawLine

boolean Report::_pdf_drawLine(integer $width)
  • Visibility: public

Arguments

  • $width integer

_pdf_checkPageBreak

boolean Report::_pdf_checkPageBreak($height, boolean $add_page)
  • Visibility: public

Arguments

  • $height mixed
  • $add_page boolean

_pdf_displayMaximumPageLimitError

boolean Report::_pdf_displayMaximumPageLimitError()
  • Visibility: public

_pdf_checkMaximumPageLimit

boolean Report::_pdf_checkMaximumPageLimit()
  • Visibility: public

_pdf_AddPage

boolean Report::_pdf_AddPage()
  • Visibility: public

_pdf_TopSummary

boolean Report::_pdf_TopSummary()
  • Visibility: public

_html_checkMaximumPageLimit

boolean Report::_html_checkMaximumPageLimit($cur)
  • Visibility: public

Arguments

  • $cur mixed

_html_Table

boolean Report::_html_Table()
  • Visibility: public

_pdf_getMaximumHeightFromArray

integer Report::_pdf_getMaximumHeightFromArray($columns, $column_options, array $column_widths, string $wrap_width, integer $min_height)
  • Visibility: public

Arguments

  • $columns mixed
  • $column_options mixed
  • $column_widths array
  • $wrap_width string - UUID
  • $min_height integer

_pdf_Header

boolean Report::_pdf_Header()
  • Visibility: public

_pdf_Footer

boolean Report::_pdf_Footer()
  • Visibility: public

_pdf_Chart

boolean Report::_pdf_Chart()
  • Visibility: public

_html_Chart

boolean Report::_html_Chart()
  • Visibility: public

_html_CSS

string Report::_html_CSS()
  • Visibility: public

_html_setPageOrientationCSS

string Report::_html_setPageOrientationCSS()
  • Visibility: public

_html_Initialize

boolean Report::_html_Initialize()
  • Visibility: public

_pdf_Initialize

boolean Report::_pdf_Initialize()
  • Visibility: public

_html

boolean|null|string Report::_html()
  • Visibility: public

_html_Footer

mixed Report::_html_Footer()
  • Visibility: public

_html_Header

boolean Report::_html_Header()
  • Visibility: public

_html_TopSummary

boolean Report::_html_TopSummary()
  • Visibility: public

_pdf

boolean Report::_pdf()
  • Visibility: public

getSubTotalColumnLabelPosition

boolean|mixed Report::getSubTotalColumnLabelPosition($row, $columns, $sub_total_columns)
  • Visibility: public

Arguments

  • $row mixed
  • $columns mixed
  • $sub_total_columns mixed

_pdf_Table

boolean Report::_pdf_Table()
  • Visibility: public

downloadOutput

boolean Report::downloadOutput()
  • Visibility: public

emailOutput

boolean Report::emailOutput()
  • Visibility: public

setCustomColumnConfig

boolean Report::setCustomColumnConfig($columns)
  • Visibility: public

Arguments

  • $columns mixed

getCustomColumnConfig

boolean|mixed Report::getCustomColumnConfig()
  • Visibility: public

calculateCustomColumns

boolean Report::calculateCustomColumns(integer $type_id)
  • Visibility: public

Arguments

  • $type_id integer

calculateCustomColumnFilters

boolean Report::calculateCustomColumnFilters(integer $type_id)
  • Visibility: public

Arguments

  • $type_id integer

Clone this wiki locally