JobDetailReport - staffcheck/api GitHub Wiki

JobDetailReport

  • Class name: JobDetailReport
  • Namespace:
  • Parent class: Report

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

__construct

mixed Report::__construct()

Report constructor.

  • Visibility: public
  • This method is defined by Report

_checkPermissions

boolean JobDetailReport::_checkPermissions(string $user_id, string $company_id)
  • Visibility: protected

Arguments

  • $user_id string - UUID
  • $company_id string - UUID

_validateConfig

boolean JobDetailReport::_validateConfig()
  • Visibility: protected

_getOptions

boolean Report::_getOptions($name, null $params)
  • Visibility: protected
  • This method is defined by Report

Arguments

  • $name mixed
  • $params null

_getData

boolean JobDetailReport::_getData(null $format)
  • Visibility: public

Arguments

  • $format null

_preProcess

boolean JobDetailReport::_preProcess()
  • Visibility: public

_output

array|boolean Report::_output(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

__getOptions

array|null Report::__getOptions($name, null $params)
  • Visibility: protected
  • This method is defined by Report

Arguments

  • $name mixed
  • $params null

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
  • This method is defined by Report

Arguments

  • $bool mixed

getEnableSystemColumns

boolean Report::getEnableSystemColumns()
  • Visibility: public
  • This method is defined by Report

setExecutionTimeLimit

boolean Report::setExecutionTimeLimit(boolean $int)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $int boolean

setExecutionMemoryLimit

boolean Report::setExecutionMemoryLimit(boolean $str)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $str boolean

isSystemLoadValid

boolean Report::isSystemLoadValid()
  • Visibility: public
  • This method is defined by Report

setUserObject

boolean Report::setUserObject(object $obj)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $obj object

getUserObject

null Report::getUserObject()
  • Visibility: public
  • This method is defined by Report

setPermissionObject

boolean Report::setPermissionObject(object $obj)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $obj object

getPermissionObject

null Report::getPermissionObject()
  • Visibility: public
  • This method is defined by Report

getCurrencyConvertToBase

boolean Report::getCurrencyConvertToBase()

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

  • Visibility: public
  • This method is defined by Report

getBaseCurrencyObject

boolean|object Report::getBaseCurrencyObject()
  • Visibility: public
  • This method is defined by Report

handleReportCurrency

boolean Report::handleReportCurrency($currency_convert_to_base, object $base_currency_obj, $filter_data)
  • Visibility: public
  • This method is defined by Report

Arguments

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

setCurrencyObject

boolean Report::setCurrencyObject(object $obj)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $obj object

getCurrencyObject

null Report::getCurrencyObject()
  • Visibility: public
  • This method is defined by Report

getTable

string Report::getTable()
  • Visibility: public
  • This method is defined by Report

getProgressBarObject

null|\ProgressBar Report::getProgressBarObject()
  • Visibility: public
  • This method is defined by Report

getAMFMessageID

boolean|null Report::getAMFMessageID()
  • Visibility: public
  • This method is defined by Report

setAMFMessageID

boolean Report::setAMFMessageID(string $id)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $id string - UUID

setConfig

boolean Report::setConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getConfig

array Report::getConfig()
  • Visibility: public
  • This method is defined by Report

getTemplate

boolean|mixed Report::getTemplate($name)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $name mixed

loadTemplate

boolean Report::loadTemplate($name)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $name mixed

setColumnConfig

boolean Report::setColumnConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getColumnConfig

boolean|mixed Report::getColumnConfig()
  • Visibility: public
  • This method is defined by Report

setColumnDataConfig

boolean Report::setColumnDataConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getColumnDataConfig

boolean|mixed Report::getColumnDataConfig()
  • Visibility: public
  • This method is defined by Report

convertTimePeriodToStartEndDate

array|boolean Report::convertTimePeriodToStartEndDate($time_period_arr, null $prefix, boolean $force_dates_for_pay_periods)
  • Visibility: public
  • This method is defined by Report

Arguments

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

setFilterConfig

boolean Report::setFilterConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getFilterConfig

boolean|mixed Report::getFilterConfig()
  • Visibility: public
  • This method is defined by Report

convertArrayNumericKeysToString

array|boolean Report::convertArrayNumericKeysToString($arr)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $arr mixed

formatGroupConfig

array|boolean Report::formatGroupConfig()
  • Visibility: public
  • This method is defined by Report

setGroupConfig

boolean Report::setGroupConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getGroupConfig

boolean|mixed Report::getGroupConfig()
  • Visibility: public
  • This method is defined by Report

getReportColumns

boolean|mixed Report::getReportColumns(boolean $num)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $num boolean

formatSubTotalConfig

array|boolean Report::formatSubTotalConfig()
  • Visibility: public
  • This method is defined by Report

setSubTotalConfig

boolean Report::setSubTotalConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getSubTotalConfig

boolean|mixed Report::getSubTotalConfig()
  • Visibility: public
  • This method is defined by Report

setSortConfig

boolean Report::setSortConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getSortConfig

boolean|mixed Report::getSortConfig()
  • Visibility: public
  • This method is defined by Report

setCompanyFormConfig

boolean Report::setCompanyFormConfig(null $data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data null

getCompanyFormConfig

boolean Report::getCompanyFormConfig()
  • Visibility: public
  • This method is defined by Report

setFormConfig

boolean Report::setFormConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getFormConfig

boolean|mixed Report::getFormConfig()
  • Visibility: public
  • This method is defined by Report

setOtherConfig

boolean Report::setOtherConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getOtherConfig

boolean|mixed Report::getOtherConfig()
  • Visibility: public
  • This method is defined by Report

isEnabledChart

boolean Report::isEnabledChart()
  • Visibility: public
  • This method is defined by Report

setChartConfig

boolean Report::setChartConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getChartConfig

boolean|mixed Report::getChartConfig()
  • Visibility: public
  • This method is defined by Report

setCustomFilterConfig

boolean Report::setCustomFilterConfig($data)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $data mixed

getCustomFilterConfig

boolean|mixed Report::getCustomFilterConfig()
  • Visibility: public
  • This method is defined by Report

validateConfig

null|\Validator Report::validateConfig(boolean $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format boolean

getFileName

string Report::getFileName()
  • Visibility: public
  • This method is defined by Report

getFileMimeType

string Report::getFileMimeType()
  • Visibility: public
  • This method is defined by Report

getOptions

boolean|mixed Report::getOptions($name, null $params)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $name mixed
  • $params null

getData

boolean Report::getData($format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format mixed

preProcess

boolean Report::preProcess(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

group

boolean Report::group()
  • Visibility: public
  • This method is defined by Report

sort

boolean Report::sort()
  • Visibility: public
  • This method is defined by Report

sortFormData

boolean Report::sortFormData()
  • Visibility: public
  • This method is defined by Report

Total

boolean Report::Total()
  • Visibility: public
  • This method is defined by Report

subTotal

boolean Report::subTotal()
  • Visibility: public
  • This method is defined by Report

chart

boolean Report::chart()
  • Visibility: public
  • This method is defined by Report

postProcess

boolean Report::postProcess(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

columnFormatter

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

Arguments

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

getTimePeriodFormatOptions

array Report::getTimePeriodFormatOptions(array $format_options)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format_options array

getCustomColumnFormatOptions

array Report::getCustomColumnFormatOptions(array $format_options)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format_options array

currencyConvertToBase

boolean Report::currencyConvertToBase()
  • Visibility: public
  • This method is defined by Report

getColumnFormatConfig

array Report::getColumnFormatConfig()
  • Visibility: public
  • This method is defined by Report

_postProcess

boolean Report::_postProcess(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

getDescriptionBlock

string Report::getDescriptionBlock(boolean $html, boolean $relative_time_period)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $html boolean
  • $relative_time_period boolean

getDescription

boolean|string Report::getDescription($label, null $params)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $label mixed
  • $params null

checkPermissions

boolean Report::checkPermissions()
  • Visibility: public
  • This method is defined by Report

setQueryStatementTimeout

boolean Report::setQueryStatementTimeout(null $milliseconds)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $milliseconds null

getOutput

array|boolean Report::getOutput(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

_preOutput

boolean Report::_preOutput(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

_postOutput

boolean Report::_postOutput(null $format)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $format null

hasData

boolean Report::hasData()
  • Visibility: public
  • This method is defined by Report

email

boolean Report::email($output, object $report_schedule_obj)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $output mixed
  • $report_schedule_obj object

_pdf_detectPageSize

array Report::_pdf_detectPageSize($column_options, $columns)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $column_options mixed
  • $columns mixed

getLargestColumnData

array Report::getLargestColumnData($columns, boolean $include_headers)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $columns mixed
  • $include_headers boolean

_pdf_getColumnWidth

float|integer Report::_pdf_getColumnWidth($text, $layout, boolean $wrap_width)
  • Visibility: public
  • This method is defined by Report

Arguments

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

_pdf_getColumnHeight

float|integer Report::_pdf_getColumnHeight($text, $layout, boolean $wrap_width)
  • Visibility: public
  • This method is defined by Report

Arguments

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

_pdf_getLargestWrappedWord

null Report::_pdf_getLargestWrappedWord($string, string $width, $layout)
  • Visibility: public
  • This method is defined by Report

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
  • This method is defined by Report

Arguments

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

_pdf_unitsToPixels

mixed Report::_pdf_unitsToPixels($size)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $size mixed

_pdf_scaleSize

float Report::_pdf_scaleSize($size)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $size mixed

_pdf_fontSize

float Report::_pdf_fontSize($size)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $size mixed

_html_fontSize

float Report::_html_fontSize($size)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $size mixed

_pdf_getPageSizeDimensionsFromWidth

array Report::_pdf_getPageSizeDimensionsFromWidth(string $min_width)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $min_width string - UUID

_pdf_drawLine

boolean Report::_pdf_drawLine(integer $width)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $width integer

_pdf_checkPageBreak

boolean Report::_pdf_checkPageBreak($height, boolean $add_page)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $height mixed
  • $add_page boolean

_pdf_displayMaximumPageLimitError

boolean Report::_pdf_displayMaximumPageLimitError()
  • Visibility: public
  • This method is defined by Report

_pdf_checkMaximumPageLimit

boolean Report::_pdf_checkMaximumPageLimit()
  • Visibility: public
  • This method is defined by Report

_pdf_AddPage

boolean Report::_pdf_AddPage()
  • Visibility: public
  • This method is defined by Report

_pdf_TopSummary

boolean Report::_pdf_TopSummary()
  • Visibility: public
  • This method is defined by Report

_html_checkMaximumPageLimit

boolean Report::_html_checkMaximumPageLimit($cur)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $cur mixed

_html_Table

boolean Report::_html_Table()
  • Visibility: public
  • This method is defined by Report

_pdf_getMaximumHeightFromArray

integer Report::_pdf_getMaximumHeightFromArray($columns, $column_options, array $column_widths, string $wrap_width, integer $min_height)
  • Visibility: public
  • This method is defined by Report

Arguments

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

_pdf_Header

boolean Report::_pdf_Header()
  • Visibility: public
  • This method is defined by Report

_pdf_Footer

boolean Report::_pdf_Footer()
  • Visibility: public
  • This method is defined by Report

_pdf_Chart

boolean Report::_pdf_Chart()
  • Visibility: public
  • This method is defined by Report

_html_Chart

boolean Report::_html_Chart()
  • Visibility: public
  • This method is defined by Report

_html_CSS

string Report::_html_CSS()
  • Visibility: public
  • This method is defined by Report

_html_setPageOrientationCSS

string Report::_html_setPageOrientationCSS()
  • Visibility: public
  • This method is defined by Report

_html_Initialize

boolean Report::_html_Initialize()
  • Visibility: public
  • This method is defined by Report

_pdf_Initialize

boolean Report::_pdf_Initialize()
  • Visibility: public
  • This method is defined by Report

_html

boolean|null|string Report::_html()
  • Visibility: public
  • This method is defined by Report

_html_Footer

mixed Report::_html_Footer()
  • Visibility: public
  • This method is defined by Report

_html_Header

boolean Report::_html_Header()
  • Visibility: public
  • This method is defined by Report

_html_TopSummary

boolean Report::_html_TopSummary()
  • Visibility: public
  • This method is defined by Report

_pdf

boolean Report::_pdf()
  • Visibility: public
  • This method is defined by Report

getSubTotalColumnLabelPosition

boolean|mixed Report::getSubTotalColumnLabelPosition($row, $columns, $sub_total_columns)
  • Visibility: public
  • This method is defined by Report

Arguments

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

_pdf_Table

boolean Report::_pdf_Table()
  • Visibility: public
  • This method is defined by Report

downloadOutput

boolean Report::downloadOutput()
  • Visibility: public
  • This method is defined by Report

emailOutput

boolean Report::emailOutput()
  • Visibility: public
  • This method is defined by Report

setCustomColumnConfig

boolean Report::setCustomColumnConfig($columns)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $columns mixed

getCustomColumnConfig

boolean|mixed Report::getCustomColumnConfig()
  • Visibility: public
  • This method is defined by Report

calculateCustomColumns

boolean Report::calculateCustomColumns(integer $type_id)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $type_id integer

calculateCustomColumnFilters

boolean Report::calculateCustomColumnFilters(integer $type_id)
  • Visibility: public
  • This method is defined by Report

Arguments

  • $type_id integer
⚠️ **GitHub.com Fallback** ⚠️