Interface ReportInterface

Report interface that all reports must implement

Direct known implementers

AgingInvoices, ClientDataPortability, CustomReport, InvoiceCreation, PackageRevenue, TaxLiability, TransactionsApplied, TransactionsReceived

Package: blesta\components\reports
Copyright: Copyright (c) 2018, Phillips Data, Inc.
License: The Blesta License Agreement
Link: Blesta
Located at components/reports/report_interface.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`	# `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
`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
`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
`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

Packages

Classes

Interfaces

Interface ReportInterface

Direct known implementers

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns