Download the PHP package stesa/phpjasper without Composer

PHPJasper

A Laravel package for generating reports with JasperReports using the latest version of JasperStarter. Generate beautiful PDF, Excel, CSV, HTML, and other format reports from your Laravel application with ease.

Features

• Latest JasperReports: Uses JasperReports 7.0.3 via custom JasperStarter build
• Multiple Output Formats: PDF, Excel (XLS/XLSX), CSV, HTML, XML, and more
• Database Support: MySQL and PostgreSQL out of the box
• Fluent API: Intuitive, Laravel-style chainable methods
• Barcode Support: Full support for barcodes including Code128, Code39, QR codes, etc.
• JSON Output: Structured error handling and detailed logging
• Easy Integration: Automatic service provider discovery, facade support
• Comprehensive: Report compilation, execution, and parameter listing

Requirements

• PHP 8.0 or higher
• Laravel 9.0, 10.0, 11.0, or 12.0
• Java Runtime Environment (JRE) 24 or higher

Installation

1. Install via Composer

2. Publish Configuration (Optional)

This will create config/phpjasper.php for customization.

3. Publish Example Templates (Optional)

4. Verify Java Installation

Make sure Java is installed and accessible:

You should see Java 24 or higher.

Quick Start

Basic Usage

Using in Controller

API Reference

Compile

Compile a JRXML template to JASPER format:

Parameters:

• $inputFile (string): Path to .jrxml file
• $outputFile (string, optional): Output path for .jasper file

Example:

Process

Generate a report from a JASPER or JRXML file:

Parameters:

• $inputFile (string): Path to .jasper or .jrxml file
• $outputFile (string): Output file path (without extension)
• $options (array): Report options

Options:

Example:

List Parameters

List all parameters in a JASPER report:

Example:

Multiple Output Formats

Generate reports in multiple formats simultaneously:

Database Connections

Using Default Laravel Database

Using PostgreSQL

Report Parameters

Pass parameters to your reports:

In your JRXML, reference parameters like:

Configuration

The package can be configured via config/phpjasper.php:

Environment Variables

Add to your .env file:

Using Multiple Java Versions

If you have multiple Java versions installed, you can specify which one to use:

Via Configuration:

Via Environment Variable:

Programmatically:

Supported Formats

• PDF - Portable Document Format
• XLSX - Microsoft Excel 2007+
• XLS - Microsoft Excel (Legacy)
• CSV - Comma-separated values
• HTML - HTML format
• XML - XML format
• JRPRINT - JasperReports print format

Check supported formats:

Barcode Support

This package includes full barcode support through Barcode4J integration:

Supported Barcode Types:

• Code128
• Code39
• EAN-13, EAN-8
• UPC-A, UPC-E
• Codabar
• PDF417
• DataMatrix
• QR Code

Example JRXML Barcode Component:

Directory Structure

Recommended directory structure for reports:

Create directories:

Error Handling

The package throws exceptions with detailed error messages:

Advanced Usage

Get Command Without Executing

Custom JAR Path

Using Dependency Injection

Troubleshooting

Java Not Found

Error: java: command not found

Solution: Install Java JRE 24 or higher and ensure it's in your system PATH.

JAR File Not Found

Error: JasperStarter JAR not found

Solution: The JAR file should be automatically included in the vendor directory. If missing, check your composer installation or manually specify the path in config.

Database Connection Failed

Error: Database connection error

Solution:

• Verify database credentials
• Ensure database server is running
• Check firewall settings
• Verify database driver (mysql/postgresql)

Compilation Errors

Error: Unable to load report

Solution:

• Validate XML syntax in JRXML file
• Ensure JRXML uses UTF-8 encoding
• Check JasperReports version compatibility (should be 7.0.3 or lower)
• Use JasperSoft Studio 6.20.x or earlier to create templates

Creating Reports

Using JasperSoft Studio

1. Download JasperSoft Studio 6.20.x or earlier
2. Create a new report or open existing .jrxml template
3. Design your report with fields, parameters, and formatting
4. Save the .jrxml file to your templates directory
5. Use PHPJasper to compile and generate reports

Report Design Tips

• Use parameters for dynamic values: $P{parameter_name}
• Use fields for database columns: $F{column_name}
• Use variables for calculations: $V{variable_name}
• Store images in the resources directory
• Test reports in JasperSoft Studio before using in Laravel

Performance Tips

1. Pre-compile templates: Compile .jrxml to .jasper during deployment
2. Use queued jobs: For large reports, use Laravel queues to avoid timeouts
3. Clean up old reports: Regularly delete old files from output directory
4. Cache compiled reports: Store compiled .jasper files for reuse
5. Optimize queries: Ensure database queries in reports are optimized

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

Credits

• Steven Samoy - Package creator
• JasperStarter - Based on custom build: ssamoy/jasperstarter
• JasperReports - Powered by JasperReports 7.0.3
• PHPJasper - Inspired by PHPJasper/phpjasper

License

This package is open-sourced software licensed under the MIT license.

Support

If you encounter any issues or have questions:

• Create an issue on GitHub
• Check existing issues for solutions
• Review the JasperStarter documentation

Changelog

See CHANGELOG.md for version history and changes.