Class ClientDataPortability

ClientDataPortability report

ClientDataPortability implements ReportInterface uses Blesta\Core\Util\Common\Traits\Container

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

Methods used from Blesta\Core\Util\Common\Traits\Container
`getFromContainer()`

Packages

Classes

Class ClientDataPortability

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Implementation of

Parameters

Returns

Implementation of

Returns