# KoolReport

> KoolReport is an open-source PHP reporting framework (koolreport/core on Packagist; PHP 7.0 or newer, tested up to 8.5) with a commercial Pro bundle (koolreport/pro) of extra widgets and features. A report is a PHP class that pipes data from data sources through processes into data stores, plus a view file that renders widgets (tables, charts, pivot tables, inputs) from those data stores. Current version: 6.8.0 (core and Pro).

Read llms-full.txt for the complete reference with code. The essentials:

- A report is a class extending `\koolreport\KoolReport` (`settings()` for data sources, `setup()` for the pipeline into `$this->dataStore("name")`) plus a `<ClassName>.view.php` that calls `Widget::create(array(...))`.
- Widgets take `"dataSource" => $this->dataStore("name")`. Google Charts are `koolreport\widgets\google\*`; the core table and card are `koolreport\widgets\koolphp\Table` and `Card`.
- Pro packages install from `https://repo.koolreport.com` with credentials in `auth.json`.

## Reference

- [Full reference](https://www.koolreport.com/llms-full.txt): everything below in one file
- [Install](https://www.koolreport.com/docs/installation/)
- [Report anatomy](https://www.koolreport.com/docs/quick_start/)
- [Data sources](https://www.koolreport.com/docs/datasources/overview/)
- [Processes (the data pipeline)](https://www.koolreport.com/docs/processes/overview/)
- [Widgets: common settings](https://www.koolreport.com/docs/data_visualization/widget/)
- [Table (core)](https://www.koolreport.com/docs/koolphp/table/)
- [Chart libraries and their namespaces](https://www.koolreport.com/docs/google_charts/overview/)
- [DataTables grid (koolreport/datagrid)](https://www.koolreport.com/docs/datagrid/datatables/)
- [Pivot tables (koolreport/pivot)](https://www.koolreport.com/docs/pivot/overview/)
- [Cube / cross-tab (koolreport/cube)](https://www.koolreport.com/docs/cube/overview/)
- [Drill-down (koolreport/drilldown)](https://www.koolreport.com/docs/drilldown/drilldown/)
- [Inputs and filter forms (koolreport/inputs)](https://www.koolreport.com/docs/inputs/overview/)
- [Export to Excel (koolreport/excel)](https://www.koolreport.com/docs/excel/overview/)
- [Query builder (koolreport/querybuilder)](https://www.koolreport.com/docs/querybuilder/overview/)
- [KPI card (core)](https://www.koolreport.com/docs/koolphp/card/)