StatisticsOverviewService
in package
implements
StatisticsOverviewService
Class representing the domain's service.
Interfaces, Classes and Traits
- StatisticsOverviewService
- Interface representing domain's service.
Table of Contents
- $factory : StatisticsOverviewFactory
- Factory.
- $provider : StatisticsOverviewWidgetDefinitionProvider
- Widget provider.
- $storage : StatisticsOverviewWidgetOptionsStorage
- Widget's configuration value storage.
- __construct() : mixed
- Constructor.
- configureWidget() : void
- Save widget options.
- getWidgetsByCategory() : OverviewWidgets
- Get widgets by category.
- createWidget() : OverviewWidget
- Return widget.
Properties
$factory
Factory.
private
StatisticsOverviewFactory
$factory
$provider
Widget provider.
private
StatisticsOverviewWidgetDefinitionProvider
$provider
$storage
Widget's configuration value storage.
private
StatisticsOverviewWidgetOptionsStorage
$storage
Methods
__construct()
Constructor.
public
__construct(StatisticsOverviewWidgetDefinitionProvider $provider, StatisticsOverviewWidgetOptionsStorage $storage, StatisticsOverviewFactory $factory) : mixed
Parameters
- $provider : StatisticsOverviewWidgetDefinitionProvider
-
Widget provider.
- $storage : StatisticsOverviewWidgetOptionsStorage
-
Widget's configuration value storage.
- $factory : StatisticsOverviewFactory
-
Factory.
Return values
mixed —configureWidget()
Save widget options.
public
configureWidget(string $id, array<string|int, mixed> $options) : void
Parameters
- $id : string
-
Widget's ID.
- $options : array<string|int, mixed>
-
Widget's options.
Tags
Return values
void —getWidgetsByCategory()
Get widgets by category.
public
getWidgetsByCategory(string $category) : OverviewWidgets
Parameters
- $category : string
-
Widget's category.
Tags
Return values
OverviewWidgets —Widgets.
createWidget()
Return widget.
private
createWidget(WidgetDefinition $definition) : OverviewWidget
Parameters
- $definition : WidgetDefinition
-
Widget's definition.
Tags
Return values
OverviewWidget —Widget instance.