README

PHPJasper

PHP报告生成器

文档

请考虑捐赠，支持我们的活动

关于

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

我们在discord的频道

https://discord.gg/7FpDnQ

注意

PHPJasper可以与任何PHP框架一起使用
对于7.0以下的PHP版本，请参阅：v1.16
这里有使用PHPJasper的几个示例

为什么选择PHPJasper？

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

我必须这样做，而现有的解决方案并不完美。生成HTML + CSS以创建PDF？这没有任何意义！ :)

然后我发现了最好的开源报告解决方案JasperReports。

我能用它做什么？

好吧，一切。JasperReports是报告和BI的强大工具。

从他们的网站

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

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

您可以做一些示例

发票
报告
列表

要求

PHP 7.2或更高版本
Java JDK 1.8

可选

任何jdbc驱动程序，可以从数据库（MySQL、POSTGRES、MSSQL...）生成报告，必须复制到文件夹bin/jasperstarter/jdbc
我们在bin/jasperstarter/jdbc目录中提供了PostgreSQL（42.2.9）。
我们在bin/jasperstarter/jdbc目录中提供了MySQL连接器（v5.1.48）。
Microsoft JDBC Drivers SQL Server.
Jaspersoft Studio（用于绘制您的报告）。

安装

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

composer require geekcom/phpjasper

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

{
    "require": {
        "geekcom/phpjasper": "^3.2.0"
    }
}

然后只需运行

composer install

就这样了。

PHPJasper与Docker

安装Docker CE和docker-compose后，只需运行

docker-compose up -d
docker exec -it phpjasper composer install

要执行测试

docker exec -it phpjasper sudo composer test 或
docker exec -it phpjasper sudo composer testdox

要手动查看测试覆盖率，请执行文件：tests/log/report/index.html

帮助我们编写新的测试，创建分支 :)

示例

《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();

性能

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

我有一个报告，该报告生成带有DB连接、图像和多个页面的发票，处理时间约为3/4秒。我建议您使用工作进程在后台生成报告。

谢谢

Cenote GmbH为JasperStarter工具。

JetBrains为PhpStorm和所有优秀工具。

有疑问吗？

打开一个新的问题或查找已关闭的问题

许可证

MIT

贡献

贡献者✨

感谢这些美好的人们（emoji key）

此项目遵循all-contributors规范。欢迎任何形式的贡献！

muhammettotan / phpjasper

维护者

详细信息