PHPackages                             f5sistemas/phpjasper - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [PDF & Document Generation](/categories/documents)
4. /
5. f5sistemas/phpjasper

ActiveLibrary[PDF & Document Generation](/categories/documents)

f5sistemas/phpjasper
====================

A PHP report generator

3.3.1(6y ago)01MITPHPPHP ^7.2

Since Dec 1Pushed 5y agoCompare

[ Source](https://github.com/f5sistemas/phpjasper)[ Packagist](https://packagist.org/packages/f5sistemas/phpjasper)[ Fund](https://nubank.com.br/pagar/518o5/zVBzxd00Sb)[ RSS](/packages/f5sistemas-phpjasper/feed)WikiDiscussions master Synced today

READMEChangelogDependencies (4)Versions (33)Used By (0)

[![PHPJasper logo](docs/images/phpjasper.png)](docs/images/phpjasper.png)

PHPJasper
=========

[](#phpjasper)

*A PHP Report Generator*

[![Build Status](https://camo.githubusercontent.com/0996c9b8bb16d883890a602a3d9f51e8759cc1f195c1674fb3f7d49558170296/68747470733a2f2f7472617669732d63692e636f6d2f5048504a61737065722f7068706a61737065722e7376673f6272616e63683d6d6173746572)](https://travis-ci.com/PHPJasper/phpjasper)[![Coverage Status](https://camo.githubusercontent.com/f9a9004102f28d43780bd3e13376c373b5c10c6b19b4991ed491805181613efd/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f5048504a61737065722f7068706a61737065722f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/PHPJasper/phpjasper?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/6f97ac3df277773888a60fd95d11c6cf5e540a0a895332b53d14ea42d9e33de7/68747470733a2f2f706f7365722e707567782e6f72672f6765656b636f6d2f7068706a61737065722f762f737461626c65)](https://packagist.org/packages/geekcom/phpjasper)[![Minimum PHP Version](https://camo.githubusercontent.com/25464688f91a67a0299e341f26126c0e880aab6c4851a35d68c095786be2d354/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253230372e322d626c75652e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![Total Downloads](https://camo.githubusercontent.com/228217129d1ddfe689c0385ea46cb4daa29ae2dfd489fcb29e2341e9101f5d37/68747470733a2f2f706f7365722e707567782e6f72672f6765656b636f6d2f7068706a61737065722f646f776e6c6f616473)](https://packagist.org/packages/geekcom/phpjasper)[![License](https://camo.githubusercontent.com/3cf2cc8e264818e5b275ef603da4add42d73fcdee52a655b1967fe0ac647b9b3/68747470733a2f2f706f7365722e707567782e6f72672f6765656b636f6d2f7068706a61737065722f6c6963656e7365)](https://packagist.org/packages/geekcom/phpjasper)[![PHPStan](https://camo.githubusercontent.com/441b5874ce4df0a2defc892979c96c46889b69cb32119d04f0b48626349f8bc9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f5048505374616e2d656e61626c65642d627269676874677265656e2e7376673f7374796c653d666c6174)](https://github.com/phpstan/phpstan)[![All Contributors](https://camo.githubusercontent.com/6639f2ea5527f4e3f1af2ec8d6e72c1384242c492b7787833429d3f3c2188d79/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f616c6c5f636f6e7472696275746f72732d31322d6f72616e67652e7376673f7374796c653d666c61742d737175617265)](#contributors-)

### Docs

[](#docs)

[![Language-pt_BR](https://camo.githubusercontent.com/d658a81c76bb885913209e0a7935d9f78963001497ea3c4037dcd3127c052ed9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70745f5f42522d3130302532352d677265656e2e7376673f7374796c653d666c61742d737175617265)](https://github.com/PHPJasper/phpjasper/blob/master/docs/pt_BR/LEIA-ME_pt_BR.md)

### About

[](#about)

PHPJasper is the best solution to compile and process JasperReports (.jrxml & .jasper files) just using PHP, in short: to generate reports using PHP.

#### Our channel on discord

[](#our-channel-on-discord)

**Notes:**

- PHPJasper Can be used regardless of your PHP Framework
- For PHP versions less than 7.0 see: [v1.16](https://github.com/PHPJasper/phpjasper/releases/tag/v1.16)
- [Here](https://github.com/PHPJasper/examples) are several examples of how to use PHPJasper

### Why PHPJasper?

[](#why-phpjasper)

Did you ever had to create a good looking Invoice with a lot of fields for your great web app?

I had to, and the solutions out there were not perfect. Generating *HTML* + *CSS* to make a *PDF*? That doesn't make any sense! :)

Then I found **JasperReports** the best open source solution for reporting.

### What can I do with this?

[](#what-can-i-do-with-this)

Well, everything. JasperReports is a powerful tool for **reporting** and **BI**.

**From their website:**

> The JasperReports Library is the world's most popular open source reporting engine. It is entirely written in Java and it is able to use data coming from any kind of data source and produce pixel-perfect documents that can be viewed, printed or exported in a variety of document formats including HTML, PDF, Excel, OpenOffice and Word.

It is recommended using [Jaspersoft Studio](http://community.jaspersoft.com/project/jaspersoft-studio) to build your reports, connect it to your datasource (ex: MySQL, POSTGRES), loop thru the results and output it to PDF, XLS, DOC, RTF, ODF, etc.

*Some examples of what you can do:*

- Invoices
- Reports
- Listings

Requirements
------------

[](#requirements)

- PHP 7.2 or above
- Java JDK 1.8

Optional
--------

[](#optional)

- Any `jdbc` drivers to generate reports from a database (MySQL, PostgreSQL, MSSQL...), must be copied to a folder `bin/jasperstarter/jdbc`
- We ship the [PostgreSQL](https://jdbc.postgresql.org/) (42.2.9) in the `bin/jasperstarter/jdbc` directory.
- We ship the [MySQL connector](http://dev.mysql.com/downloads/connector/j/) (v5.1.48) in the `bin/jasperstarter/jdbc` directory.
- [Microsoft JDBC Drivers SQL Server ](https://docs.microsoft.com/en-us/sql/connect/jdbc/download-microsoft-jdbc-driver-for-sql-server?view=sql-server-ver15).
- [Jaspersoft Studio](http://community.jaspersoft.com/project/jaspersoft-studio) (to draw your reports).

Installation
------------

[](#installation)

Install [Composer](http://getcomposer.org) if you don't have it.

```
composer require geekcom/phpjasper

```

Or in your file'composer.json' add:

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

And the just run:

```
composer install

```

and thats it.

---

PHPJasper with Docker
---------------------

[](#phpjasper-with-docker)

With Docker CE and docker-compose installed just run:

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

To execute tests:

- `docker exec -it phpjasper sudo composer test` or
- `docker exec -it phpjasper sudo composer testdox`

To see coverage manually of tests, execute the file: `tests/log/report/index.html`

*Help us writing new tests, make a fork* :)

---

Examples
--------

[](#examples)

### The *Hello World* example.

[](#the-hello-world-example)

Go to the examples directory in the root of the repository (`vendor/geekcom/phpjasper/examples`). Open the `hello_world.jrxml` file with Jaspersoft Studio or with your favorite text editor and take a look at the source code.

#### Compiling

[](#compiling)

First we need to compile our `JRXML` file into a `JASPER` binary file. We just have to do this one time.

**Note 1:** You don't need to do this step if you are using *Jaspersoft Studio*. You can compile directly within the program.

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

use PHPJasper\PHPJasper;

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

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

This commando will compile the `hello_world.jrxml` source file to a `hello_world.jasper` file.

#### Processing

[](#processing)

Now lets process the report that we compile before:

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

Now check the examples folder! :) Great right? You now have 2 files, `hello_world.pdf` and `hello_world.rtf`.

Check the *methods* `compile` and `process` in `src/JasperPHP.php` for more details

#### Listing Parameters

[](#listing-parameters)

Querying the jasper file to examine parameters available in the given jasper report file:

```
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 . '';
```

### Using database to generate reports

[](#using-database-to-generate-reports)

We can also specify parameters for connecting to database:

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

**Note 2:**

For a complete list of locales see [Supported Locales](http://www.oracle.com/technetwork/java/javase/java8locales-2095355.html)

### Using MSSQL DataBase

[](#using-mssql-database)

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

### Reports from a XML

[](#reports-from-a-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();
```

### Reports from a JSON

[](#reports-from-a-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();
```

Performance
-----------

[](#performance)

Depends on the complexity, amount of data and the resources of your machine (let me know your use case).

I have a report that generates a *Invoice* with a DB connection, images and multiple pages and it takes about **3/4 seconds** to process. I suggest that you use a worker to generate the reports in the background.

Thanks
------

[](#thanks)

[Cenote GmbH](http://www.cenote.de/) for the [JasperStarter](http://jasperstarter.sourceforge.net/) tool.

[JetBrains](https://www.jetbrains.com/) for the [PhpStorm](https://www.jetbrains.com/phpstorm/) and all great tools.

[Questions?](https://github.com/PHPJasper/phpjasper/issues)
-----------------------------------------------------------

[](#questions)

Open a new [Issue](https://github.com/PHPJasper/phpjasper/issues) or look for a closed issue

[License](https://github.com/PHPJasper/phpjasper/blob/master/LICENSE)
---------------------------------------------------------------------

[](#license)

MIT

[Contribute](https://github.com/PHPJasper/phpjasper/blob/master/CONTRIBUTING.md)
--------------------------------------------------------------------------------

[](#contribute)

Contributors ✨
--------------

[](#contributors-)

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  [![](https://avatars2.githubusercontent.com/u/3955933?v=4)
**Daniel Rodrigues**](https://twitter.com/geekcom2)
[🚇](#infra-geekcom "Infrastructure (Hosting, Build-Tools, etc)") [🚧](#maintenance-geekcom "Maintenance") [💻](https://github.com/PHPJasper/phpjasper/commits?author=geekcom "Code") [![](https://avatars2.githubusercontent.com/u/13982234?v=4)
**Leandro Bitencourt**](http://www.leandrobitencourt.com.br)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=lavela "Code") [![](https://avatars3.githubusercontent.com/u/1079143?v=4)
**Vitor Mattos**](https://github.com/vitormattos)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=vitormattos "Code") [![](https://avatars0.githubusercontent.com/u/275919?v=4)
**Rafael Queiroz**](https://github.com/rafaelqueiroz)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=rafaelqueiroz "Code") [![](https://avatars0.githubusercontent.com/u/5477476?v=4)
**Dave Bould**](http://dave.codes)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=dbould "Code") [![](https://avatars1.githubusercontent.com/u/32931011?v=4)
**ThiagoAlves31**](https://github.com/ThiagoAlves31)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=ThiagoAlves31 "Code") [![](https://avatars3.githubusercontent.com/u/10354607?v=4)
**Jadson Ribeiro**](http://www.jadsonbr.com.br)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=jadsonbr "Code")   [![](https://avatars0.githubusercontent.com/u/6140?v=4)
**Fernando Boaglio**](http://www.boaglio.com)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=boaglio "Code") [![](https://avatars3.githubusercontent.com/u/1639945?v=4)
**Rahul Jain**](https://rahulja.in)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=xRahul "Code") [![](https://avatars2.githubusercontent.com/u/431453?v=4)
**Luiz Eduardo**](https://github.com/lecneri)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=lecneri "Code") [![](https://avatars0.githubusercontent.com/u/11426456?v=4)
**David Ribeiro**](https://github.com/davidribeiro)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=davidribeiro "Code") [![](https://avatars3.githubusercontent.com/u/8092154?v=4)
**James Allen**](https://allenjd3.github.io)
[💻](https://github.com/PHPJasper/phpjasper/commits?author=allenjd3 "Code") This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

###  Health Score

28

—

LowBetter than 54% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity1

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity69

Established project with proven stability

 Bus Factor1

Top contributor holds 68.6% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~52 days

Recently: every ~44 days

Total

31

Last Release

2243d ago

Major Versions

v1.15 → 2.02017-05-26

v1.16 → v2.12017-06-01

v2.7 → 3.0.02019-03-17

PHP version history (4 changes)v1.0PHP >=5.4.0

2.0PHP >=7.1

v2.5PHP >=7.0

3.2.0PHP ^7.2

### Community

Maintainers

![](https://www.gravatar.com/avatar/6e920e49e26471fed9bf56a1aeaa147973b4bf84026c83add40ad400e590f19c?d=identicon)[F5 Software de Gestão](/maintainers/F5%20Software%20de%20Gest%C3%A3o)

---

Top Contributors

[![geekcom](https://avatars.githubusercontent.com/u/3955933?v=4)](https://github.com/geekcom "geekcom (243 commits)")[![allcontributors[bot]](https://avatars.githubusercontent.com/in/23186?v=4)](https://github.com/allcontributors[bot] "allcontributors[bot] (48 commits)")[![rafaelqueiroz](https://avatars.githubusercontent.com/u/275919?v=4)](https://github.com/rafaelqueiroz "rafaelqueiroz (19 commits)")[![lavela](https://avatars.githubusercontent.com/u/13982234?v=4)](https://github.com/lavela "lavela (15 commits)")[![leandrocopam](https://avatars.githubusercontent.com/u/33423387?v=4)](https://github.com/leandrocopam "leandrocopam (8 commits)")[![ThiagoAlves31](https://avatars.githubusercontent.com/u/32931011?v=4)](https://github.com/ThiagoAlves31 "ThiagoAlves31 (5 commits)")[![dbould](https://avatars.githubusercontent.com/u/5477476?v=4)](https://github.com/dbould "dbould (5 commits)")[![boaglio](https://avatars.githubusercontent.com/u/6140?v=4)](https://github.com/boaglio "boaglio (2 commits)")[![jadsonbr](https://avatars.githubusercontent.com/u/10354607?v=4)](https://github.com/jadsonbr "jadsonbr (2 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (1 commits)")[![vitormattos](https://avatars.githubusercontent.com/u/1079143?v=4)](https://github.com/vitormattos "vitormattos (1 commits)")[![xRahul](https://avatars.githubusercontent.com/u/1639945?v=4)](https://github.com/xRahul "xRahul (1 commits)")[![f5sistemas](https://avatars.githubusercontent.com/u/8289942?v=4)](https://github.com/f5sistemas "f5sistemas (1 commits)")[![davidribeiro](https://avatars.githubusercontent.com/u/11426456?v=4)](https://github.com/davidribeiro "davidribeiro (1 commits)")[![lecneri](https://avatars.githubusercontent.com/u/431453?v=4)](https://github.com/lecneri "lecneri (1 commits)")[![allenjd3](https://avatars.githubusercontent.com/u/8092154?v=4)](https://github.com/allenjd3 "allenjd3 (1 commits)")

---

Tags

pdfreportsphp-reports

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/f5sistemas-phpjasper/health.svg)

```
[![Health](https://phpackages.com/badges/f5sistemas-phpjasper/health.svg)](https://phpackages.com/packages/f5sistemas-phpjasper)
```

###  Alternatives

[geekcom/phpjasper

A PHP report generator

493258.4k1](/packages/geekcom-phpjasper)[geekcom/phpjasper-laravel

A PHP report generator

3341.9k](/packages/geekcom-phpjasper-laravel)[robregonm/yii2-pdf

Yii 2 PDF Response Formatter

4647.5k1](/packages/robregonm-yii2-pdf)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)