Download the PHP package phil/reporting-bundle without Composer
On this page you can find all versions of the php package phil/reporting-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phil/reporting-bundle
More information about phil/reporting-bundle
Files in phil/reporting-bundle
Package reporting-bundle
Short Description Dashboards and reports for Symfony: metrics and series from any bundle through a data-source port, dashboards as Twig components with accessible HTML, CSS and SVG charts and a table of every value, an optional EasyAdmin page, and CSV, TSV or JSON reports scheduled with Scheduler and delivered by Mailer or Notifier through a Messenger claim check
License MIT
Homepage https://ph-il.ca
Informations about the package reporting-bundle
phil/reporting-bundle
Dashboards and reports for Symfony applications: figures contributed by any bundle, charts drawn without a script, reports exported, scheduled and delivered.
phil/reporting-bundle gathers what an application measures in one place. Any bundle, or the application itself,
contributes a figure — orders taken, a renewal rate — as a MetricSource, and a series — visits by day, sales by
category — as a SeriesSource. The configuration places them on dashboards; Twig components show a dashboard, a
metric or a chart on any page, and an EasyAdmin back office shows a dashboard as one of its pages when EasyAdmin is
installed.
The charts are HTML, CSS and SVG, never a script. An SVG image is drawn on the server by phil/svg-chart, with a
title, a description that reads every value, and the table of its values beside it; bars of HTML and CSS are a table
themselves; a table alone is a third rendering. A metric shows its value written in the reader's locale, and its
change from the period before.
A report is a service with columns and rows, read row by row: exported to CSV, TSV or JSON, streamed as a download, written from the command line, or scheduled with Symfony Scheduler and delivered by Mailer or Notifier from a Messenger worker. A message carries an identifier only: the job, with its recipients and parameters, and the exported file wait in stores readable by their owner — the claim check.
It relies on the library phil/svg-chart to draw the images; Symfony UX, Messenger, Scheduler, Mailer,
Notifier, Console and EasyAdmin are each used when they are installed.
Status
| Part | State |
|---|---|
MetricSource, SeriesSource: the data-source port, found by key |
Implemented and tested |
Period, Metric, Series, SeriesSet, with limits; PeriodPreset, counted in the configured time zone |
Implemented and tested |
| Dashboards in the configuration, restricted to a role when one is named | Implemented and tested |
PhilReporting:Dashboard, :LiveDashboard, :Metric, :Chart components |
Implemented and tested |
| SVG, HTML and table renderings; a stylesheet on the tokens of PHIL UX, no inline style | Implemented and tested |
ReportDefinition, ReportFormat (CSV, TSV, JSON), formula cells neutralised, rows bounded |
Implemented and tested |
ReportQueue, RunReport, the job and export stores of the claim check |
Implemented and tested |
The phil_reporting schedule of Symfony Scheduler |
Implemented and tested |
The mail and notification deliveries |
Implemented and tested |
ReportResponses downloads, phil:reporting:export, the EasyAdmin page |
Implemented and tested |
Documentation
| Document | What it covers |
|---|---|
| Installation | Requirements, enabling the bundle, the stylesheet. |
| Configuration | Every key of phil_reporting. |
| Sources | Contributing metrics and series, periods and limits. |
| Dashboards | The components, the renderings, their accessibility, EasyAdmin. |
| Reports | Definitions, formats, downloads, the command, schedules, deliveries and the claim check. |
| Extension points | What an application may replace or add, and when it is stable. |
| Testing | The bundle's tests, and testing code that uses it. |
| Reference | Every public type, with its role. |
Quick start
Requirements
PHP 8.5 or later, with intl, json, mbstring and sodium; Symfony 8.2.
Contributing
Contributions are welcome on the PHIL monorepo: read the contribution guide and the security policy explains, never in a public issue.
License
MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. See LICENSE.
All versions of reporting-bundle with dependencies
ext-intl Version *
ext-json Version *
ext-mbstring Version *
ext-sodium Version *
phil/svg-chart Version ^0.1@dev
psr/clock Version ^1.0
psr/event-dispatcher Version ^1.0
symfony/config Version ^8.2
symfony/dependency-injection Version ^8.2
symfony/service-contracts Version ^3.6