PHPackages                             ra-hael-heilbuth/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. ra-hael-heilbuth/phpjasper

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

ra-hael-heilbuth/phpjasper
==========================

Gerador de relatórios PHP

v3.0(8y ago)012MITPHPPHP >=7.0

Since Dec 1Pushed 5y agoCompare

[ Source](https://github.com/raphael-heilbuth/phpjasper)[ Packagist](https://packagist.org/packages/ra-hael-heilbuth/phpjasper)[ RSS](/packages/ra-hael-heilbuth-phpjasper/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (1)Versions (9)Used By (0)

PHPJasper
=========

[](#phpjasper)

*A PHP Report Generator*

[![Scrutinizer Code Quality](https://camo.githubusercontent.com/4a234bba0167ce440fd6561d4d7dad1edad52cd73d84e7d59be8e39f656c13ea/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f6c6176656c612f7068706a61737065722f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/lavela/phpjasper/?branch=master)[![Latest Stable Version](https://camo.githubusercontent.com/77565f40aa997b483060ef7d6b58a2c3ac00d111e449f786f02f7c532623420b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6c6176656c612f7068706a61737065722e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/lavela/phpjasper)[![Minimum PHP Version](https://camo.githubusercontent.com/1bd3780069a2c9b3a714282820283a36be97183cfdc1afb3a887bc4ae639a524/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f7068702d253345253344253230372e302d626c75652e7376673f7374796c653d666c61742d737175617265)](https://php.net/)[![License](https://camo.githubusercontent.com/6fc410f6f398b3ff2b1a64b37076266325f97dca2faf845968c0bec16063858d/68747470733a2f2f706f7365722e707567782e6f72672f6c6176656c612f7068706a61737065722f6c6963656e7365)](https://packagist.org/packages/lavela/phpjasper)

### Docs

[](#docs)

[![Language-pt_BR](https://camo.githubusercontent.com/6821f40b23a0dc5f7e29abbe7dde5708a2180d5c7ff2fb19f3bd4e94143c8625/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f70745f5f42522d3130302532352d677265656e2e737667)](https://github.com/lavela/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.

**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.0 or above
- Java JDK 1.8

Optional
--------

[](#optional)

- [Mysql JDBC Driver](http://dev.mysql.com/downloads/connector/j/) (If you want to use a database)
- [PostgreSQL JDBC Driver](https://jdbc.postgresql.org/download.html) (If you want to use a database)
- [Microsoft JDBC Drivers](https://www.microsoft.com/en-US/download/details.aspx?id=11774) (If you want to use a database)
- [Jaspersoft Studio](http://community.jaspersoft.com/project/jaspersoft-studio) (to draw and compile your reports)

### Java(JDK)

[](#javajdk)

Check if you already have Java installed:

```
$ javac -version
javac version 1.8.0_101

```

If you get:

```
command not found: javac

```

Then install it with: (Ubuntu/Debian)

```
$ sudo apt-get install default-jdk

```

To install on: (centOS/Fedora)

```
# yum install java-1.8.0-openjdk.x86_64

```

To install on windows visit the link-> [JDK](http://www.oracle.com/technetwork/pt/java/javase/downloads/jdk8-downloads-2133151.html) and look for the most appropriate version for your system.

Now run the `javac -version` again and check if the output is ok.

---

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

[](#installation)

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

```
composer require lavela/phpjasper

```

Or in your file'composer.json' add:

```
{
    "require": {
        "lavela/phpjasper": "^3.0"
    }
}
```

And the just run:

```
composer install

```

and thats it.

---

Examples
--------

[](#examples)

### The *Hello World* example.

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

Go to the examples directory in the root of the repository (`vendor/lavela/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/lavela/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/lavela/phpjasper/examples/hello_world.jasper';
$output = __DIR__ . '/vendor/lavela/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/lavela/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/lavela/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();
```

### MySQL

[](#mysql)

We ship the [MySQL connector](http://dev.mysql.com/downloads/connector/j/) (v5.1.39) in the `/src/JasperStarter/jdbc/` directory.

### PostgreSQL

[](#postgresql)

We ship the [PostgreSQL](https://jdbc.postgresql.org/) (v9.4-1203) in the `/src/JasperStarter/jdbc/` directory.

### MSSQL

[](#mssql)

[Microsoft JDBC Drivers 6.0, 4.2, 4.1, and 4.0 for SQL Server ](https://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=11774).

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)

Contribute to the community PHP, make a fork!

###  Health Score

27

—

LowBetter than 49% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity5

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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 ~137 days

Recently: every ~181 days

Total

7

Last Release

2988d ago

Major Versions

v1.4 → v2.02017-05-10

v2.0 → v3.02018-03-07

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

v3.0PHP >=7.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/def239ebe89891acf0dceab9184551cb7a7643ad07882ebfaa19a8f6d96180d6?d=identicon)[raphael-heilbuth](/maintainers/raphael-heilbuth)

---

Top Contributors

[![lavela](https://avatars.githubusercontent.com/u/13982234?v=4)](https://github.com/lavela "lavela (17 commits)")[![Dericktan](https://avatars.githubusercontent.com/u/16285179?v=4)](https://github.com/Dericktan "Dericktan (9 commits)")[![leandrocopam](https://avatars.githubusercontent.com/u/33423387?v=4)](https://github.com/leandrocopam "leandrocopam (8 commits)")[![geekcom](https://avatars.githubusercontent.com/u/3955933?v=4)](https://github.com/geekcom "geekcom (5 commits)")[![raphael-heilbuth](https://avatars.githubusercontent.com/u/70953533?v=4)](https://github.com/raphael-heilbuth "raphael-heilbuth (5 commits)")[![lfrugere](https://avatars.githubusercontent.com/u/1849971?v=4)](https://github.com/lfrugere "lfrugere (1 commits)")

---

Tags

pdfrelatórios

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/ra-hael-heilbuth-phpjasper/health.svg)

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

###  Alternatives

[barryvdh/laravel-dompdf

A DOMPDF Wrapper for Laravel

7.3k87.6M278](/packages/barryvdh-laravel-dompdf)[tecnickcom/tcpdf

TCPDF is a PHP class for generating PDF documents and barcodes.

4.5k101.8M473](/packages/tecnickcom-tcpdf)[mpdf/mpdf

PHP library generating PDF files from UTF-8 encoded HTML

4.7k77.1M493](/packages/mpdf-mpdf)[knplabs/knp-snappy

PHP library allowing thumbnail, snapshot or PDF generation from a url or a html page. Wrapper for wkhtmltopdf/wkhtmltoimage.

4.5k68.3M56](/packages/knplabs-knp-snappy)[spatie/browsershot

Convert a webpage to an image or pdf using headless Chrome

5.2k32.1M102](/packages/spatie-browsershot)[smalot/pdfparser

Pdf parser library. Can read and extract information from pdf file.

2.7k34.5M216](/packages/smalot-pdfparser)

PHPackages © 2026

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