Interface LaravelUi5\Core\Ui5\Contracts\KpiProviderInterface

Contract for KPI data providers delivering live metric values.

Implementations must return a valid associative array that represents a complete KPI snapshot suitable for rendering inside UI5 dashboards.

A provider receives the aggregation level (e.g., monthly, weekly) and a set of context parameters (e.g. 'project_id' => 42) to produce the data.

Located at Ui5/Contracts/KpiProviderInterface.php

Methods


					
	public

toJson(AggregationLevel $aggregationLevel, array<string, mixed> $context): array<string, mixed>

Returns the data payload for the KPI tile.

The returned array should match the expected UI5 JSON structure, typically including keys such as 'value', 'valueColor', 'indicator', 'unit', 'scale', and optionally a trend or target.

Parameters

`$aggregationLevel`	Level of data grouping (daily, weekly, etc.)
`$context`	Contextual filters like project ID, year, etc.

Returns

KPI payload as an associative array

Namespaces

Interfaces

Interface LaravelUi5\Core\Ui5\Contracts\KpiProviderInterface

Parameters

Returns