webuccinoco/sre-community

一个开源的PHP报表框架,允许您直接从项目动态创建专业的报表(适用于MYSQL或Maria DB)。

v1.1.4 2023-08-14 00:51 UTC

This package is auto-updated.

Last update: 2024-09-23 18:36:09 UTC


README

Smart Report Engine 是一个用户友好的PHP报表框架,它允许您在项目中轻松地以编程方式创建专业报表。

Watch the video

入门指南

1- 您可以选择克隆Smart Report Engine的社区版,或者直接从此下载页面下载。

2- 下载后,解压缩文件夹以显示SmartReportEngine的结构。内容将类似于以下内容

├── SmartReportingEngine/
├── sre_config/
   └── config.php
├── sre_reports/
├── db/
  └── example.sql
├── examples/
└── sre_bootstrap.php

Watch the video

3- 要在您的服务器上启动第一个项目,您需要导入一个MySQL示例数据库。此过程将使您能够顺利地开始使用Smart Report Engine。

  • 在Smart Report Engine下载包中,找到“db”目录下的“/db/example.sql”文件。此SQL文件包含创建和填充名为'items'的单个MySQL表的必要命令
  • 选择您第一个项目设置所用的MySQL数据库。您可以选择现有的数据库或为该项目创建一个新的数据库。
  • 将“example.sql”文件导入您选择的MySQL数据库。这将创建“items”表并填充初始数据。

4- 配置数据库连接字符串

  • 导航到Smart Report Engine社区版包内的“sre_config”目录。在那里,您将找到“config.php”文件。请使用您喜欢的任何文本编辑器打开此文件。
  • 在“config.php”文件中,您将找到一个专门用于数据库配置的部分。使用在第3步中导入示例SQL文件时使用的MySQL数据库的适当详细信息更新连接字符串。确保在各自的字段中提供正确的域名、数据库名称、用户名和密码。

5- 保存对“config.php”文件的更改。

6- 在社区版的“/examples”目录中,您将找到三个有用的示例,以帮助您开始使用Smart Report Engine。要执行任何这些示例,只需从您的网络浏览器访问它们的URL即可。这将使您能够查看根据每个示例中的代码生成的报表。

7- 如果您更喜欢从头开始构建示例项目,请按照安装过程中的第8步继续操作。

注意:无论您的选择如何,代码浏览部分将为每个示例中的代码提供解释。

8- 要开始编写您的第一个项目,您需要一个新的PHP脚本。为了本教程的目的,您可以将脚本添加到社区版的根目录中,与“sre_bootstrap.php”文件位于同一级别。如果您手动下载了社区版(未使用Composer),您需要在代码中引入“sre_bootstrap.php”自动加载文件,如下面的示例所示。如果您的代码放置在其他项目的不同位置,请确保相应地调整此自动加载文件的路径。请按照以下步骤开始您的项目

  • 为您的项目创建一个新的PHP脚本。
  • 可选地,为了本教程的目的,将脚本放置在社区版的根目录中(与“sre_bootstrap.php”同一级别)。
  • 在您的第一个新项目中,尝试编写以下简单的PHP代码。它应该没有问题。
use SRE\Engine\CustomEngine;
use SRE\Engine\ReportOptions;

require_once "sre_bootstrap.php";

try {

   $report = new ReportOptions();
   $report->select_tables("items")
           ->set_grouping("country")
           ->set_title("Items Per country")
           ->select_all_fields();
   $engine = new CustomEngine($report);
   $report_path = $engine->create_report();
   if ($report_path) {
      // The user will be redirected to the URL of the generated report. All generated reports are stored as subdirectories under /sre_reports.
      header("location: ".$report_path);
      exit();
   }
} catch (Exception $e) {
   echo $e->getMessage();
}

生成此报表

代码浏览:理解示例

以下代码演示了如何有效地使用智能报告引擎的基本示例。让我们一步一步地分析代码,了解其工作原理。

  • 命名空间:给定代码使用了两个命名空间,即 "SRE\Engine\CustomEngine" 和 "SRE\Engine\ReportOptions"。这些命名空间有助于组织和访问代码的特定部分。
  • 要求 "sre_bootstrap.php":如果您手动下载了社区版(未使用Composer),则需要将一个名为 "sre_bootstrap.php" 的特殊文件添加到您的代码中。
  • 创建 ReportOptions 对象:代码初始化一个来自 "ReportOptions" 类的对象。该对象负责定义报告所需的选项。您可以自定义各种选项,但请注意,一些功能仅限于商业版。
  • 将 ReportOptions 对象传递给 CustomEngine:设置报告选项后,您需要将 "ReportOptions" 对象传递给 "CustomEngine" 类的构造函数。此类根据提供的选项处理报告的创建。
  • 调用 CreateReport 函数:要生成报告,请使用 "CustomEngine" 对象调用 "CreateReport" 函数。此函数处理定义的选项并生成报告。在成功创建后,它返回报告的URL。所有使用智能报告引擎生成的报告都将自动保存在 "sre_reports" 目录中。

重要链接

  • 更多示例
  • 详细许可比较为了帮助您更好地理解社区版和商业版之间的区别,我们在本页提供了一个简明的概述。它突出了每个版本在功能和用例方面的主要差异。
  • 智能报告引擎故障排除本节中的目的是指导用户在遇到使用智能报告引擎生成报告过程中出现的任何问题时考虑关键检查点。此外,我们还将探讨智能报告引擎的日志功能,该功能有助于解决可能出现在生成的报告中的潜在问题。
  • 智能报告引擎文档在本节中,您将发现关于智能报告引擎每个内置类、方法和常量的全面文档和示例。
  • 最新功能本节将包括智能报告引擎中引入的最新功能。
  • 智能报告引擎主页
  • 联系我们

社区版许可

社区版允许您
  • 实验智能报告引擎(仅限非高级功能)。
  • 免费将智能报告引擎用于个人用途。
  • 只要保留我们的版权声明,就可以免费将智能报告引擎集成到免费开源项目中。
社区版限制您
  • 访问高级功能。
  • 将智能报告引擎集成到商业或SaaS项目中。
  • 从由社区版Smart Report Maker生成的报告中移除“由...提供支持”的声明。

注意:使用我们的任何商业版,您将获得访问所有高级功能的权限,以及移除上述社区版限制。

智能报告引擎Pro

智能报告引擎Pro是智能报告引擎的高级版本,提供了所有高级功能的访问权限。仅以64美元的团队许可证价格,Pro版提供了许多优势,包括

  • 完全访问所有高级功能。
  • 可用于SaaS和商业项目。
  • 与任何现有的基于会话的登录系统轻松集成。
  • 生成报告中页脚缺少“由...提供支持”的声明。
  • 赠送一年免费的升级服务。
  • 未来升级费用的70%折扣(在免费升级期之后)。
  • 优先客户支持。
  • 能够在无限数量的服务器或项目中部署智能报告引擎。
  • 团队许可允许最多7名开发者使用,而企业许可允许组织内无限数量的开发者使用。
  • 当您将智能报告引擎与您的商业产品一起交付时,可享受皇家免费(无额外费用)。

作者

Webuccino 自2007年以来致力于创造易于使用的产品