PHPackages                             dericktan/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. dericktan/phpjasper

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

dericktan/phpjasper
===================

Create Reports in PHP with JasperReports

v1.5.1(9y ago)2363MITHTMLPHP >=5.4.0

Since Dec 1Pushed 9y ago2 watchersCompare

[ Source](https://github.com/Dericktan/phpjasper)[ Packagist](https://packagist.org/packages/dericktan/phpjasper)[ Docs](https://github.com/Dericktan/phpjasper)[ RSS](/packages/dericktan-phpjasper/feed)WikiDiscussions master Synced today

READMEChangelog (1)DependenciesVersions (10)Used By (0)

JasperReports for PHP and Laravel Framework
===========================================

[](#jasperreports-for-php-and-laravel-framework)

[![Latest Stable Version](https://camo.githubusercontent.com/26a9191e765e249038473ea6262dd67f0487536311e0b2e647bafb8193b77f49/68747470733a2f2f706f7365722e707567782e6f72672f64657269636b74616e2f7068706a61737065722f762f737461626c65)](https://packagist.org/packages/dericktan/phpjasper)[![License](https://camo.githubusercontent.com/49382ac809796033a02b8037ff9a25052ad5bc162855ee3a725242b774054436/68747470733a2f2f706f7365722e707567782e6f72672f64657269636b74616e2f7068706a61737065722f6c6963656e7365)](https://packagist.org/packages/dericktan/phpjasper)[![Monthly Downloads](https://camo.githubusercontent.com/758d1bccb8030a920bec967a36dfdf20ff6f8e58d4504ec214defceffea2dca3/68747470733a2f2f706f7365722e707567782e6f72672f64657269636b74616e2f7068706a61737065722f642f6d6f6e74686c79)](https://packagist.org/packages/dericktan/phpjasper)[![Total Downloads](https://camo.githubusercontent.com/ce662e65c90891f14fd0b6383417e4f0ffb31c31abb2194638b2de61425c50e0/68747470733a2f2f706f7365722e707567782e6f72672f64657269636b74616e2f7068706a61737065722f646f776e6c6f616473)](https://packagist.org/packages/dericktan/phpjasper)

**Is using Linux servers?**

Do not forget to grant permission 777 for the directory **/vendor/dericktan/phpjasper/src/JasperStarter/bin** and the file binary **jasperstarter**

\##Introduction

This package aims to be a solution to compile and process JasperReports (.jrxml & .jasper files).

\###Why?

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*? WTF? That doesn't make any sense! :)

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

\###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.

I recommend 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

Package to generate reports with [JasperReports 6](http://community.jaspersoft.com/project/jasperreports-library) library through [JasperStarter v3](http://jasperstarter.sourceforge.net/) command-line tool.

\##Requirements

- Java JDK 1.8
- PHP [exec()](http://php.net/manual/function.exec.php) function
- \[optional\] [Mysql Connector](http://dev.mysql.com/downloads/connector/j/) (if you want to use database)
- \[optional\] [PostgreSQL Connector](https://jdbc.postgresql.org/download.html) (if you want to use database)
- \[optional\] [Jaspersoft Studio](http://community.jaspersoft.com/project/jaspersoft-studio) (to draw and compile your reports)

\##Installation

\###Java

Check if you already have Java installed:

```
$ java -version
java version "1.8.0_65"
Java(TM) SE Runtime Environment (build 1.8.0_65-b17)
Java HotSpot(TM)  Client VM (build 25.65-b01, mixed mode, sharing)

```

If you get:

```
command not found: java

```

Then install it with: (Ubuntu/Debian)

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

```

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

\##Install

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

```
composer require dericktan/phpjasper

```

Or in your 'composer.json' file add:

```
{
    "require": {
		"dericktan/phpjasper": "1.*"
    }
}
```

And the just run:

```
composer install

```

and thats it.

\##Examples

\###The *Hello World* example.

Go to the examples directory in the root of the repository (`vendor/dericktan/phpjasper/examples`). Open the `hello_world.jrxml` file with iReport 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:** 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 JasperPHP\JasperPHP;

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

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

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

\####Processing

Now lets process the report that we compile before:

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

use JasperPHP\JasperPHP;

$input = __DIR__ . '/vendor/dericktan/phpjasper/examples/hello_world.jasper';
$output = __DIR__;

$jasper = new JasperPHP;

$jasper->process(
	$input,
	$output,
	array("pdf", "rtf")
)->execute();
```

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

Check the *API* of the `compile` and `process` functions in the file `src/JasperPHP/JasperPHP.php` file.

\####Listing Parameters

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

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

use JasperPHP\JasperPHP;

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

$jasper = new JasperPHP;
$output = $jasper->list_parameters($input)->execute();

foreach($output as $parameter_description)
    print $parameter_description . '';
```

\###Advanced example - using a database

We can also specify parameters for connecting to database:

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

use JasperPHP\JasperPHP;

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

$jasper = new JasperPHP;
$jasper->process(
	$input,
	$output,
	array("pdf", "rtf"),
	array("php_version" => phpversion()),
	array(
		'driver' => 'postgres',
		'username' => 'vagrant',
		'host' => 'localhost',
		'database' => 'samples',
		'port' => '5432',
	)
)->execute();
```

\###Using JasperPHP with Laravel 5.\*

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

```
composer require dericktan/phpjasper

```

Or in your 'composer.json' file add:

```
{
    "require": {
		"dericktan/phpjasper": "1.*"
    }
}
```

2. And the just run:

    **composer update**
3. Add to your config/app.php providers array:

    **JasperPHP\\JasperPHPServiceProvider::class,**
4. Create a folder **/report** on **/public directory**
5. Copy the file **hello\_world.jrxml** in **/vendor/dericktan/phpjasper/examples** from directory: **/public/report**
6. Run **php artisan serve**
7. Access **localhost:8000/reports**
8. Check the directory **/public/report**. You now have 3 files, `hello_world.pdf`, `hello_world.rtf` and `hello_world.xml`.

**Below the code you will use in your route.php**

```
use JasperPHP\JasperPHP;

Route::get('/reports', function () {

    $output = public_path() . '/report/'.time().'_hello_world';
    $report = new JasperPHP;
    $report->process(
    	public_path() . '/report/hello_world.jrxml',
        $output,
        array('pdf', 'rtf', 'xml'),
        array(),
        array()
        )->execute();
});
```

In this example we generate reports pdf, rtf and xml.

\###Reports from a xml in PHP/Laravel 5.\*

See how easy it is to generate a report with a source an XML file:

```
use JasperPHP\JasperPHP;

public function xmlToPdf()
    {
        $output = public_path() . '/report/'.time().'_CancelAck';
        $ext = "pdf";
        $data_file = public_path() . '/report/CancelAck.xml';
        $driver = 'xml';
        $xml_xpath = '/CancelResponse/CancelResult/ID';

        $jasper = new JasperPHP;

        $jasper->process(
            public_path() . '/report/CancelAck.jrxml',
            $output,
            array($ext),
            array(),
            array('data_file' => $data_file, 'driver' => $driver, 'xml_xpath' => $xml_xpath),
            false,
            false
        )->execute();

        header('Content-Description: File Transfer');
        header('Content-Type: application/octet-stream');
        header('Content-Disposition: attachment; filename='.time().'_CancelAck.'.$ext);
        header('Content-Transfer-Encoding: binary');
        header('Expires: 0');
        header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
        header('Content-Length: ' . filesize($output.'.'.$ext));
        flush();
        readfile($output.'.'.$ext);
        unlink($output.'.'.$ext);

    }
```

**Note:**

To use the example above you must copy the sample files located at:

**\\vendor\\dericktan\\phpjasper\\src\\JasperStarter\\examples\\CancelAck.jrxml**and **\\vendor\\dericktan\\phpjasper\\src\\JasperStarter\\examples\\CancelAck.xml**to folder: **\\public\\report**

\###Reports from a JSON File in PHP/Laravel 5.\*

See how easy it is to generate a report with a source an JSON file:

```
use JasperPHP\JasperPHP;

public function jsonToPdf()
    {
        $output = public_path() . '/report/'.time().'_Contacts';
        $ext = "pdf";
        $driver = 'json';
        $json_query= "contacts.person";
        $data_file = public_path() . '/report/contacts.json';

        $jasper = new JasperPHP;

        $jasper->process(
            public_path() . '/report/json.jrxml',
            $output,
            array($ext),
            array(),
            array('data_file' => $data_file, 'driver' => $driver, 'json_query' => $json_query
        )->execute();

        header('Content-Description: File Transfer');
        header('Content-Type: application/octet-stream');
        header('Content-Disposition: attachment; filename='.time().'_Contacts.'.$ext);
        header('Content-Transfer-Encoding: binary');
        header('Expires: 0');
        header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
        header('Content-Length: ' . filesize($output.'.'.$ext));
        flush();
        readfile($output.'.'.$ext);
        unlink($output.'.'.$ext);

    }
```

\###Set Password to exported PDF You can now set a password to PDF document easily

```
use JasperPHP\JasperPHP;

public function jsonToPdf()
    {
        $output = public_path() . '/report/'.time().'_Contacts';
        $ext = "pdf";
        $driver = 'json';
        $json_query= "contacts.person";
        $data_file = public_path() . '/report/contacts.json';
        $password = "jasper";

        $jasper = new JasperPHP;

        $jasper->process(
            public_path() . '/report/json.jrxml',
            $output,
            array($ext),
            array(),
            array('data_file' => $data_file, 'driver' => $driver, 'json_query' => $json_query,
            null,
            null,
            $password
        )->execute();

        header('Content-Description: File Transfer');
        header('Content-Type: application/octet-stream');
        header('Content-Disposition: attachment; filename='.time().'_Contacts.'.$ext);
        header('Content-Transfer-Encoding: binary');
        header('Expires: 0');
        header('Cache-Control: must-revalidate, post-check=0, pre-check=0');
        header('Content-Length: ' . filesize($output.'.'.$ext));
        flush();
        readfile($output.'.'.$ext);
        unlink($output.'.'.$ext);

    }
```

**Note:**

To use the example above you must copy the sample files located at:

**\\vendor\\dericktan\\phpjasper\\src\\JasperStarter\\examples\\CancelAck.jrxml**and **\\vendor\\dericktan\\phpjasper\\src\\JasperStarter\\examples\\CancelAck.xml**to folder: **\\public\\report**

\###MySQL

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

\###PostgreSQL

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

\##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 to [Cenote GmbH](http://www.cenote.de/) for the [JasperStarter](http://jasperstarter.sourceforge.net/) tool.

\##Questions?

Drop me a line on Skype \[leandro.bittencourt16\] or E-Mail \[\]

Drop me a line on Skype \[danielrodrigueslima\] or E-Mail \[\]

Drop me a line on E-Mail \[\]

\##License

MIT

###  Health Score

31

—

LowBetter than 66% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity17

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity64

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

Recently: every ~73 days

Total

8

Last Release

3466d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/85b53db71dea77c753d281f6b9a5f1c9984c0ceeaf56d3c1150ee2aee7efd327?d=identicon)[Dericktan](/maintainers/Dericktan)

---

Top Contributors

[![Dericktan](https://avatars.githubusercontent.com/u/16285179?v=4)](https://github.com/Dericktan "Dericktan (13 commits)")[![lavela](https://avatars.githubusercontent.com/u/13982234?v=4)](https://github.com/lavela "lavela (12 commits)")[![leandrocopam](https://avatars.githubusercontent.com/u/33423387?v=4)](https://github.com/leandrocopam "leandrocopam (7 commits)")[![geekcom](https://avatars.githubusercontent.com/u/3955933?v=4)](https://github.com/geekcom "geekcom (6 commits)")

---

Tags

phpjsonpdfxmlreportsjasperreportsjavajasper

### Embed Badge

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

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

###  Alternatives

[daandesmedt/phpheadlesschrome

A PHP wrapper for using Google Chrome Headless mode. Convert URL or HTML to a PDF / screenshot. Easy to use and OOP interfaced.

92255.6k](/packages/daandesmedt-phpheadlesschrome)[soluble/jasper

Jasper reports in PHP

101.1k](/packages/soluble-jasper)[ee/dataexporter-bundle

Easy export data to CSV, XML, HTML, JSON or XLS

4982.9k](/packages/ee-dataexporter-bundle)[kiwilan/php-ebook

PHP package to read metadata and extract covers from eBooks, comics and audiobooks.

3918.3k3](/packages/kiwilan-php-ebook)

PHPackages © 2026

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