Class CustomReport

Custom Report

CustomReport implements ReportType

Package: blesta\components\reports\custom\report
Copyright: Copyright (c) 2015, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/reports/custom_report/custom_report.php

Methods summary

`public`	# `__construct( )` Load language Load language
`public string`	# `getName( )` Retrieves the name of this report Retrieves the name of this report Returns `string` The name of the report Implementation of `ReportType::getName()`
`public string`	# `getOptions( integer $company_id, array $vars = array() )` Retrieves the view containing any additional fields to filter on for the report Retrieves the view containing any additional fields to filter on for the report Parameters `$company_id` `integer` $company_id The ID of the company to generate the report from `$vars` `array` A list of input vars (optional) Returns `string` The view Implementation of `ReportType::getOptions()`
`public array`	# `getColumns( )` Retrieves a list of names for each report column to contain Retrieves a list of names for each report column to contain Returns `array` A list of key/value pairs indicating the field, its name, and any formatting to apply Implementation of `ReportType::getColumns()`
`public Iterator`	# `fetchAll( integer $company_id, array $vars )` Execute the report Execute the report Parameters `$company_id` `integer` $company_id The ID of the company to generate the report from `$vars` `array` $vars A list of fields as given as options to the view Returns `Iterator` An iterable object containing the report data Implementation of `ReportType::fetchAll()`
`public mixed`	# `errors( )` Returns any errors Returns any errors Returns `mixed` An array of errors, false if no errors set
`protected stdClass`	# `getReport( integer $report_id )` Fetches a custom report Fetches a custom report Parameters `$report_id` `integer` $report_id Returns `stdClass` The report
`protected array`	# `getAllReports( )` Fetches all custom reports Fetches all custom reports Returns `array` An array of stdClass, each representing a report
`protected string`	# `filterQuery( string $sql )` Protect users from themselves by (weakly) preventing destructive queries Protect users from themselves by (weakly) preventing destructive queries Parameters `$sql` `string` $sql The user provided query Returns `string` The filtered query

Packages

Classes

Class CustomReport

Methods summary

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Returns

Parameters

Returns

Magic methods summary