README

Laravel 框架集成的 PHP 报告生成器

文档

关于

PHPJasper 是使用 PHP 编译和处理 JasperReports (.jrxml & .jasper 文件) 的最佳解决方案，简而言之：使用 PHP 生成报告。

备注

这里是几个 PHPJasper 使用示例

为什么选择 PHPJasper？

你是否曾需要为你的优秀 web 应用程序创建一个具有许多字段的漂亮发票？

生成 HTML + CSS 来制作 PDF？这完全没有意义！ :)

我能用这个做什么？

嗯，一切。JasperReports 是一个强大的报告和 BI 工具。

从他们的网站

JasperReports 库是全球最受欢迎的开源报告引擎。它完全用 Java 编写，能够使用来自任何类型数据源的数据，并生成像素完美的文档，可以以各种文档格式查看、打印或导出，包括 HTML、PDF、Excel、OpenOffice 和 Word。

建议使用 Jaspersoft Studio 来构建你的报告，将其连接到数据源（例如 MySQL、POSTGRES），遍历结果并将其输出到 PDF、XLS、DOC、RTF、ODF 等。

你可以做的示例

发票
报告
列表

要求

PHP 7.0 或更高版本
Laravel 5.4 或 5.5
Java JDK 1.8

可选

Mysql JDBC 驱动（如果你想使用数据库）
PostgreSQL JDBC 驱动（如果你想使用数据库）
Microsoft JDBC 驱动（如果你想使用数据库）
Jaspersoft Studio（用于绘制和编译报告）

Java（JDK）

检查你是否已经安装了 Java

$ javac -version
javac version 1.8.0_101

如果你得到

command not found: javac

那么用以下方式安装它：（Ubuntu/Debian）

$ sudo apt-get install default-jdk

在以下系统上安装：（centOS/Fedora）

# yum install java-1.8.0-openjdk.x86_64

在 Windows 上安装，请访问链接→ JDK 并查找适合你系统的最合适的版本。

现在再次运行 javac -version 并检查输出是否正常。

安装

如果你还没有安装，请安装 Composer。

composer require geekcom/phpjasper-laravel

或者在你的文件 'composer.json' 中添加

{
    "require": {
        "geekcom/phpjasper-laravel": "^1.0"
    }
}

要注册 PHPJasperServiceProvider，将其添加到数组中

'providers' => [
    // Other Service Providers
    PHPJasper\PHPJasperServiceProvider::class,
],

然后只需运行

composer install

就这样。

示例

《Hello World》示例。

前往存储库根目录中的示例目录（vendor/geekcom/phpjasper/examples）。使用 Jaspersoft Studio 或你的文本编辑器打开 hello_world.jrxml 文件，查看源代码。

编译

首先，我们需要将我们的 JRXML 文件编译成 JASPER 二进制文件。我们只需要做一次。

注意1：如果您使用的是Jaspersoft Studio，则无需执行此步骤。您可以在程序内直接编译。

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = __DIR__ . '/vendor/geekcom/phpjasper/examples/hello_world.jrxml';   

$jasper = new PHPJasper;
$jasper->compile($input)->execute();

此命令将编译hello_world.jrxml源文件为hello_world.jasper文件。

处理中

现在让我们处理之前编译的报告

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = __DIR__ . '/vendor/geekcom/phpjasper/examples/hello_world.jasper';  
$output = __DIR__ . '/vendor/geekcom/phpjasper/examples';    
$options = [ 
    'format' => ['pdf', 'rtf'] 
];

$jasper = new PHPJasper;

$jasper->process(
    $input,
    $output,
    $options
)->execute();

现在检查示例文件夹！ :) 很棒，对吧？您现在有2个文件，hello_world.pdf和hello_world.rtf。

在src/JasperPHP.php中查看methods compile和process以获取更多详细信息

列出参数

查询jasper文件以检查给定jasper报告文件中可用的参数

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = __DIR__ . '/vendor/geekcom/phpjasper/examples/hello_world_params.jrxml';

$jasper = new PHPJasper;
$output = $jasper->listParameters($input)->execute();

foreach($output as $parameter_description)
    print $parameter_description . '<pre>';

使用数据库生成报告

我们还可以指定连接到数据库的参数

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;    

$input = '/your_input_path/your_report.jasper';   
$output = '/your_output_path';
$options = [
    'format' => ['pdf'],
    'locale' => 'en',
    'params' => [],
    'db_connection' => [
        'driver' => 'postgres', //mysql, ....
        'username' => 'DB_USERNAME',
        'password' => 'DB_PASSWORD',
        'host' => 'DB_HOST',
        'database' => 'DB_DATABASE',
        'port' => '5432'
    ]
];

$jasper = new PHPJasper;

$jasper->process(
        $input,
        $output,
        $options
)->execute();

注意2

有关完整区域列表，请参阅支持的区域

使用MSSQL数据库

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = '/your_input_path/your_report.jasper or .jrxml';   
$output = '/your_output_path';
$jdbc_dir = __DIR__ . '/vendor/geekcom/phpjasper/bin/jaspertarter/jdbc';
$options = [
    'format' => ['pdf'],
    'locale' => 'en',
    'params' => [],
    'db_connection' => [
        'driver' => 'generic',
        'host' => '127.0.0.1',
        'port' => '1433',
        'database' => 'DataBaseName',
        'username' => 'UserName',
        'password' => 'password',
        'jdbc_driver' => 'com.microsoft.sqlserver.jdbc.SQLServerDriver',
        'jdbc_url' => 'jdbc:sqlserver://127.0.0.1:1433;databaseName=Teste',
        'jdbc_dir' => $jdbc_dir
    ]
];

$jasper = new PHPJasper;

$jasper->process(
        $input,
        $output,
        $options
    )->execute();

从XML生成报告

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = '/your_input_path/your_report.jasper';   
$output = '/your_output_path';
$data_file = __DIR__ . '/your_data_files_path/your_xml_file.xml';
$options = [
    'format' => ['pdf'],
    'params' => [],
    'locale' => 'en',
    'db_connection' => [
        'driver' => 'xml',
        'data_file' => $data_file,
        'xml_xpath' => '/your_xml_xpath'
    ]
];

$jasper = new PHPJasper;

$jasper->process(
    $input,
    $output,
    $options
)->execute();

从JSON生成报告

require __DIR__ . '/vendor/autoload.php';

use PHPJasper\PHPJasper;

$input = '/your_input_path/your_report.jasper';   
$output = '/your_output_path';

$data_file = __DIR__ . '/your_data_files_path/your_json_file.json';
$options = [
    'format' => ['pdf'],
    'params' => [],
    'locale' => 'en',
    'db_connection' => [
        'driver' => 'json',
        'data_file' => $data_file,
        'json_query' => 'your_json_query'
    ]
];

$jasper = new PHPJasper;

$jasper->process(
    $input,
    $output,
    $options
)->execute();

MySQL

我们在/src/JasperStarter/jdbc/目录中提供了MySQL连接器（v5.1.39）。

PostgreSQL

我们在/src/JasperStarter/jdbc/目录中提供了PostgreSQL（v9.4-1203）。

MSSQL

SQL Server的Microsoft JDBC驱动程序6.0、4.2、4.1和4.0.

性能

取决于复杂性、数据量以及您的机器资源（告诉我您的用例）。

我有一个报告，它通过数据库连接、图像和多页生成发票，处理时间大约需要3/4秒。我建议您使用工作进程在后台生成报告。

谢谢

Cenote GmbH为JasperStarter工具。

JetBrains为PhpStorm和其他优秀工具。

有问题？

创建一个新的问题或查找已关闭的问题

许可

MIT

贡献

为PHP社区贡献，创建一个分支！

geekcom / phpjasper-laravel

维护者

详细信息