tatter/报告

CodeIgniter 4 的报告管理框架

v1.1.0 2020-09-10 20:01 UTC

README

CodeIgniter 4 的报告管理框架

快速开始

  1. 使用 Composer 安装:> composer require tatter/reports
  2. App/Reports/ 创建您的报告
  3. 从 CLI 生成内容:> php spark reports:generate
  4. 访问报告内容:$reports = new \App\Reports\MyReport(); $results = $reports->get();

特性

为 CodeIgniter 4 提供了一个简洁、不干扰的框架来编写数据库报告

安装

通过 Composer 轻松安装,利用 CodeIgniter 4 的自动加载功能,并始终保持最新状态

  • > composer require tatter/reports

或者,通过下载源文件并将目录添加到 app/Config/Autoload.php 中进行手动安装。

创建报告

一旦包含库,所有资源都准备就绪,您就可以开始创建报告类了。报告可以在任何命名空间中检测到,因此可以来自您的 App\Reports 命名空间或 Reports 下的任何模块。有关编写报告类的要求,请参阅 ReportInterface

生成结果

一旦编写了所有报告类,请使用命令行界面生成报告结果

> php spark reports:generate

每个报告类都负责检查缺失的报告值,因此此命令可以定期运行(例如,通过每日 cron 任务)。

访问结果

加载所需的报告类,然后使用其 get() 方法获取所需的任何内容。如果没有参数调用 get(),它将直接从数据库返回所有内容。可选地,您可以指定数据库查询的标准,例如:

$results = $reports->get([
	'user_id'       => 56,
	'created_at >=' => '2019-03-01',
]);

get() 的其他参数允许递归结果分组(例如,$results[user_id][date] => contents)和返回内容的排序。