Reports for PHP and Laravel 5.*, with JasperReports.

Is using Linux servers?

Do not forget to grant permission 777 for the directory /vendor/geekcom/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.

It is recommended using 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.3.1 library through JasperStarter v3 command-line tool.

##Requirements

• Java JDK 1.8
• PHP exec() function
• [optional] Mysql Connector (if you want to use database)
• [optional] PostgreSQL Connector (if you want to use database)
• [optional] Jaspersoft Studio (to draw and compile your reports)

###Java

Check if you already have Java installed:

$ java -version
java version "1.8.0_101"
Java(TM) SE Runtime Environment (build 1.8.0_101-b13)
Java HotSpot(TM) 64-Bit Server VM (build 25.101-b13, mixed mode)

If you get:

command not found: java

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 and look for the most appropriate version for your system.

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

##Installation

Install Composer if you don't have it.

composer require geekcom/phpjasper

Or in your file'composer.json' add:

{
    "require": {
        "geekcom/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/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

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 JasperPHP\JasperPHP;

$input = __DIR__ . '/vendor/geekcom/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/geekcom/phpjasper/examples/hello_world.jasper';  
$output = __DIR__ . '/vendor/geekcom/phpjasper/examples';    

$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/geekcom/phpjasper/examples/hello_world_params.jrxml';

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

foreach($output as $parameter_description)
    print $parameter_description . '<pre>';

###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/geekcom/phpjasper/examples/hello_world.jrxml';   
$output = __DIR__ . '/vendor/geekcom/phpjasper/examples';    

private $conn;

public function __construct()
{
    $this->conn = [
        'driver' => 'postgres',
        'username' => 'DB_USERNAME',
        'password' => 'DB_PASSWORD',
        'host' => 'DB_HOST',
        'database' => 'DB_DATABASE',
        'schema' => 'DB_SCHEMA',
        'port' => '5432'
    ];
}    

$jasper = new JasperPHP;

$jasper->process(
        $input,
        $output,
        array("pdf", "rtf"),
        array("php_version" => phpversion()),
        $this->conn, 
        true, 
        true, 
        'pt_BR' //LOCALE *note 2
)->execute();

Note 2:

For a complete list of locales see Supported Locales

###Using JasperPHP with Laravel 5.*

1. Install Composer if you don't have it.

composer require geekcom/phpjasper

Or in your 'composer.json' file add:

{
    "require": {
        "geekcom/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/geekcom/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';
        
        $php_jasper = new JasperPHP;
        
        $php_jasper->process(
            public_path() . '/report/CancelAck.jrxml',
            $output,
            array($ext),
            array(),
            array('data_file' => $data_file, 'driver' => $driver, 'xml_xpath' => $xml_xpath))->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);
    }

Do not forget to write your route

Route::get('reports/xml', 'ReportsController@xmlToPdf');

and just go to:

http://localhost:8000/reports/xml

Note 3:

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

\vendor\geekcom\phpjasper\examples\CancelAck.jrxml and \vendor\geekcom\phpjasper\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';
            
        $php_jasper = new JasperPHP;
        
        $php_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);
    }

Do not forget to write your route

Route::get('reports/json', 'ReportsController@jsonToPdf');

and just go to:

http://localhost:8000/reports/json

Note 4:

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

\vendor\geekcom\phpjasper\examples\json.jrxml and \vendor\geekcom\phpjasper\examples\contacts.json to folder: \public\report

###MySQL

We ship the MySQL connector (v5.1.39) in the /src/JasperStarter/jdbc/ directory.

###PostgreSQL

We ship the PostgreSQL (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 for the JasperStarter tool.

##Questions?

Open a Issue

##License

MIT

##Contribute

Contribute to the community PHP and Laravel, feel free to contribute, make a fork!!