PHPackages                             nealis/jasperphp - 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. nealis/jasperphp

ActiveLibrary

nealis/jasperphp
================

Create Reports in PHP with JasperReports

0709HTML

Since Dec 30Pushed 4y ago2 watchersCompare

[ Source](https://github.com/nealis/JasperPHP)[ Packagist](https://packagist.org/packages/nealis/jasperphp)[ RSS](/packages/nealis-jasperphp/feed)WikiDiscussions master Synced today

READMEChangelogDependenciesVersions (1)Used By (0)

JasperReports for PHP
=====================

[](#jasperreports-for-php)

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.

Install
-------

[](#install)

```
composer require cossou/jasperphp

```

Introduction
------------

[](#introduction)

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

### Why?

[](#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?

[](#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), loop thru the results and output it to PDF, XLS, DOC, RTF, ODF, etc.

*Some examples of what you can do:*

- Invoices
- Reports
- Listings

Examples
--------

[](#examples)

### The *Hello World* example.

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

Go to the examples directory in the root of the repository (`vendor/cossou/jasperphp/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.

```
JasperPHP::compile(base_path('/vendor/cossou/jasperphp/examples/hello_world.jrxml'))->execute();
```

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

**Note:** If you are using Laravel 4 run `php artisan tinker` and copy &amp; paste the command above.

#### Processing

[](#processing)

Now lets process the report that we compile before:

```
JasperPHP::process(
	base_path('/vendor/cossou/jasperphp/examples/hello_world.jasper'),
	false,
	array('pdf', 'rtf'),
	array('php_version' => phpversion())
)->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

[](#listing-parameters)

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

```
$output = JasperPHP::list_parameters(
		base_path('/vendor/cossou/jasperphp/examples/hello_world.jasper')
	)->execute();

foreach($output as $parameter_description)
	echo $parameter_description;
```

### Advanced example

[](#advanced-example)

We can also specify parameters for connecting to database:

```
JasperPHP::process(
    base_path('/vendor/cossou/jasperphp/examples/hello_world.jasper'),
    false,
    array('pdf', 'rtf'),
    array('php_version' => phpversion()),
    array(
      'driver' => 'postgres',
      'username' => 'vagrant',
      'host' => 'localhost',
      'database' => 'samples',
      'port' => '5433',
    )
  )->execute();
```

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

[](#requirements)

- Java JDK 1.6
- 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\] [Jaspersoft Studio](http://community.jaspersoft.com/project/jaspersoft-studio) (to draw and compile your reports)

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

[](#installation)

### Java

[](#java)

Check if you already have Java installed:

```
$ java -version
java version "1.6.0_51"
Java(TM) SE Runtime Environment (build 1.6.0_51-b11-457-11M4509)
Java HotSpot(TM) 64-Bit Server VM (build 20.51-b01-457, mixed mode)

```

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.

### Composer

[](#composer)

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

```
composer require cossou/jasperphp

```

Or in your `composer.json` file add:

```
{
    "require": {
		"cossou/jasperphp": "~2",
    }
}
```

And the just run:

```
composer update

```

and thats it.

### Using Laravel 5?

[](#using-laravel-5)

Add `JasperPHP\JasperPHPServiceProvider::class` to config `config/app.php` in service provider

File `config/app.php`

```
