Laravel Report Generator

Generate PDF, Excel & CSV reports from Eloquent queries with a fluent API.
Zero boilerplate. Full control. Works with Laravel 10, 11 & 12.

Laravel Report Generator is a package that lets you build PDF, Excel (XLSX), and CSV reports directly from Eloquent queries or query builders using a clean, chainable API. Define columns, format values, group rows, add totals, customize styling -- all without writing HTML tables or spreadsheet logic by hand.

Key features:

• Three output formats -- PDF, Excel (XLSX), and CSV from the same fluent interface
• Multi-format export -- Define a report once, export to PDF, Excel, or CSV via ReportExporter
• Column formatting -- Transform displayed values with callbacks (displayAs) or built-in formatters (currency, date, percentage, etc.)
• Row grouping -- Group rows by one or more columns with automatic subtotals
• Advanced aggregations -- sum, avg, min, max, and count in total rows
• Conditional formatting -- Declarative rules to style cells based on data values
• Report events/hooks -- Lifecycle callbacks (onBeforeRender, onRow, onAfterRender, onComplete)
• Custom headers & footers -- Configurable content with placeholders ({page}, {date}, {title})
• Report caching -- Cache rendered output with TTL and custom keys
• Custom CSS -- Inject custom styles into PDF and Excel reports
• Memory efficient -- Uses cursor-based iteration for large datasets
• Customizable templates -- Publish and modify Blade templates to fit your design
• PDF engine flexibility -- Works with either Snappy (wkhtmltopdf) or DomPDF

Table of Contents

• Requirements
• Installation
• Quick Start
• Output Examples
• Usage
  • PDF Reports
  • Excel Reports
  • CSV Reports
• API Reference
  • Initializing a Report
  • Column Formatting
  • Built-in Column Formatters
  • Grouping & Totals
  • Conditional Formatting
  • Report Events / Hooks
  • Custom Headers & Footers
  • Multi-Format Export
  • Report Caching
  • Layout & Styling
  • Performance
  • Output Methods
• Configuration
• Customizing Templates
• Testing
• Changelog
• Contributing
• Credits
• License

Requirements

Installation

Install the package via Composer:

The service provider and facades are auto-discovered -- no manual registration needed.

PDF engine (pick one)

To generate PDF reports, install one of the supported PDF engines:

If both are installed, Snappy is used by default with an automatic fallback to DomPDF.

CSV support (optional)

Quick Start

This generates a paginated PDF report with rows grouped by city, formatted currency values, and automatic totals per group.

Output Examples

Report with Grand Total

A report using showTotal() to display an automatic sum at the bottom:

Report with Group By

A report using groupBy() combined with showTotal() -- rows are grouped by date, with subtotals after each group and a final grand total:

Usage

PDF Reports

Output methods for PDF:

Excel Reports

Simple version (direct sheet manipulation, better for large datasets):

Output methods for Excel:

CSV Reports

Requires league/csv. The .csv extension is added automatically.

Output methods for CSV:

API Reference

Initializing a Report

Column mapping supports two formats:

Column Formatting

editColumn(string $columnName, array $options)

Customize how a column is displayed:

editColumns(array $columnNames, array $options)

Apply the same formatting to multiple columns at once:

Built-in Column Formatters

Use formatColumn() for common formatting without writing closures. If a column has both editColumn with displayAs and formatColumn, the displayAs callback takes priority.

formatColumn(string $columnName, string $type, array $options = [])

formatColumns(array $columnNames, string $type, array $options = [])

Apply the same formatter to multiple columns:

Available format types:

Grouping & Totals

groupBy(string|array $column)

Group rows by one or more columns. When the group value changes, a subtotal row is inserted:

showTotal(array $columns)

Display totals for numeric columns. Each entry maps a column name to a display type:

Advanced aggregation types -- beyond sum, you can use:

Conditional Formatting

Apply CSS styles to cells based on their values. In PDF/Excel reports the styles are applied as inline CSS. CSV reports ignore formatting gracefully.

conditionalFormat(string $columnName, callable $condition, array $styles)

The condition callback receives ($cellValue, $rowObject), so you can also style based on other columns:

Report Events / Hooks

Register callbacks that fire at specific points in the report lifecycle. Useful for logging, progress tracking, auditing, and post-processing.

Multiple callbacks can be registered for the same event -- they fire in registration order.

Custom Headers & Footers

Customize the header and footer content of PDF reports. Supports positional placement and placeholders.

setHeaderContent(string $content, string $position = 'center')

setFooterContent(string $content, string $position = 'center')

clearHeader() / clearFooter()

Remove all header or footer content:

Available placeholders:

Defaults:

Multi-Format Export

Define a report once and export to multiple formats without duplicating configuration. Use ReportExporter to build the report, then call toPdf(), toExcel(), or toCsv().

ReportExporter supports all the same fluent methods as the individual report classes (editColumn, formatColumn, groupBy, showTotal, conditionalFormat, cacheFor, etc.).

Report Caching

Cache the rendered report output to avoid re-rendering on repeated requests. Cached HTML is stored via Laravel's cache system.

cacheFor(int $minutes)

Enable caching with a TTL in minutes:

cacheAs(string $key)

Set a custom cache key (otherwise an auto-generated key based on title, columns, meta, limit, and groupBy is used):

cacheUsing(string $store)

Use a specific cache store (e.g., redis, file, array):

noCache()

Explicitly disable caching (useful to override a previously set cacheFor):

On cache hit, the template rendering step is skipped entirely and the cached HTML is loaded directly into the PDF/CSV engine.

Layout & Styling

setPaper(string $size) (PDF only)

Set the paper size. Default: a4.

setOrientation(string $orientation) (PDF only)

Set page orientation. Default: portrait.

setCss(array $styles) (PDF & Excel)

Inject custom CSS rules into the report template:

showHeader(bool $value = true)

Show or hide the column header row. Default: true.

showMeta(bool $value = true)

Show or hide the meta information section. Default: true (except CSV, which defaults to false).

showNumColumn(bool $value = true)

Show or hide the auto-incrementing row number column (No). Default: true.

Performance

limit(int $n)

Limit the number of rows processed:

withoutManipulation()

Skip column editing logic entirely for faster generation. Uses a simpler template that renders raw column values:

simple() (Excel only)

Use direct sheet manipulation instead of Blade template rendering. Better for large datasets:

Configuration

Publish the config file:

This creates config/report-generator.php:

Customizing Templates

Publish the Blade templates to customize the report layout:

This publishes four templates to resources/views/vendor/laravel-report-generator/:

Testing

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

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

Credits

• Samuel Terra
• All Contributors

License

The MIT License (MIT). Please see License File for more information.