Interface ReportType

Report Type interface that all reports must implement

Direct known implementers

AgingInvoices, CustomReport, InvoiceCreation, TaxLiability, TransactionsApplied, TransactionsReceived

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

Methods summary

`public string`	# `getName( )` Retrieves the name of this report Retrieves the name of this report Returns `string` The name of the report
`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
`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
`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

Packages

Classes

Interfaces

Interface ReportType

Direct known implementers

Methods summary

Returns

Parameters

Returns

Returns

Parameters

Returns

Magic methods summary