Class CustomReport

Custom Report

CustomReport implements ReportInterface

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 `ReportInterface::getName()`
`public string`	# `getFormats( )` Retrieves a list of formats supported by this report Retrieves a list of formats supported by this report Returns string The list of formats supported by this report Implementation of `ReportInterface::getFormats()`
`public string`	# `getOptions( integer $company_id, array $vars = [] )` 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` The ID of the company to generate the report from `$vars` list of input vars (optional) Returns string The view Implementation of `ReportInterface::getOptions()`
`public array`	# `getKeyInfo( )` Retrieves a list of data keys included in the report and information about them Retrieves a list of data keys included in the report and information about them Returns array A list of key/value pairs indicating the field, its name, and any formatting to apply Implementation of `ReportInterface::getKeyInfo()`
`public Iterator`	# `fetchAll( integer $company_id, array $vars )` Execute the report Execute the report Parameters `$company_id` The ID of the company to generate the report from `$vars` A list of fields as given as options to the view Returns `Iterator` An iterable object containing the report data Implementation of `ReportInterface::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` 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` The user provided query Returns string The filtered query

Packages

Classes

Class CustomReport

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Parameters

Returns

Returns

Parameters

Returns