https://github.com/jimmy-js/pdf-report-generators
[DEPRECATED] This package is no longer maintained. Migrate to https://github.com/Jimmy-JS/laravel-report-generator
https://github.com/jimmy-js/pdf-report-generators
laravel pdf pdf-report report
Last synced: about 1 year ago
JSON representation
[DEPRECATED] This package is no longer maintained. Migrate to https://github.com/Jimmy-JS/laravel-report-generator
- Host: GitHub
- URL: https://github.com/jimmy-js/pdf-report-generators
- Owner: Jimmy-JS
- License: mit
- Created: 2017-01-31T17:00:47.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-05-10T10:08:48.000Z (almost 9 years ago)
- Last Synced: 2025-01-17T13:52:12.708Z (about 1 year ago)
- Topics: laravel, pdf, pdf-report, report
- Language: HTML
- Homepage: https://packagist.org/packages/jimmyjs/laravel-report-generator
- Size: 550 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# This package is deprecated!
Please go to https://github.com/Jimmy-JS/laravel-report-generator instead!
# Laravel - Pdf Report Generators
Rapidly Generate Simple Pdf Report on Laravel (Using [barryvdh/laravel-dompdf](https://github.com/barryvdh/laravel-dompdf))
This package provides a simple pdf generators to speed up your workflow
## Installation
Add package to your composer:
composer require jimmyjs/pdf-report-generators
Then, add the ServiceProvider to the providers array in config/app.php
Jimmyjs\PdfReportGenerators\ServiceProvider::class,
## Usage
This package is make use of `chunk` method (Eloquent / Query Builder) so it can handle big data without memory exhausted.
Also, You can use `PdfReportGenerator` facade for shorter code that already registered as an alias for `Jimmyjs\PdfReportGenerators\Facade` class.
### Example Code
```php
use PdfReportGenerator;
public function displayReport(Request $request) {
// Retrieve any filters
$fromDate = $request->input('from_date');
$toDate = $request->input('to_date');
$sortBy = $request->input('sort_by');
// Report title
$title = 'Registered User Report';
// For displaying filters description on header
$meta = [
'Registered on' => $fromDate . ' To ' . $toDate,
'Sort By' => $sortBy
];
// Do some querying..
$queryBuilder = User::select(['name', 'balance', 'registered_at'])
->whereBetween('registered_at', [$fromDate, $toDate])
->orderBy($sortBy);
// Set Column to be displayed
$columns = [
'Name' => 'name',
'Registered At' => 'registered_at',
'Total Balance' => 'balance',
'Status' => function($result) { // You can do if statement or any action do you want inside this closure
return ($result->balance > 100000) ? 'Rich Man' : 'Normal Guy';
}
];
/*
Generate Report with flexibility to manipulate column class even manipulate column value (using Carbon, etc).
- of() : Init the title, meta (filters description to show), query, column (to be shown)
- editColumn() : To Change column class or manipulate its data for displaying to report
- showTotal() : Used to sum all value on specified column on the last table (except using groupBy method). 'point' is a type for displaying total with a thousand separator
- groupBy() : Show total of value on specific group. Used with showTotal() enabled.
- limit() : Limit record to be showed
- make() : Will producing DomPDF instance so you could do any other DomPDF method such as stream() or download()
*/
return PdfReportGenerator::of($title, $meta, $queryBuilder, $columns)
->editColumn('Registered At', [
'displayAs' => function($result) {
return $result->registered_at->format('d M Y');
}
])
->editColumn('Total Balance', [
'class' => 'right bold',
'displayAs' => function($result) {
return thousandSeparator($result->balance);
}
])
->editColumn('Status', [
'class' => 'right bold'
])
->showTotal([
'Total Balance' => 'point'
])
->limit(20)
->make()
->stream(); // or download() to download pdf
}
```
### Note
```php
$columns = [
'Name' => 'name',
'Registered At' => 'registered_at',
'Total Balance' => 'balance',
'Status' => function($result) { // You can do if statement or any action do you want inside this closure
return ($result->balance > 100000) ? 'Rich Man' : 'Normal Guy';
}
];
```
Will produce a same result with:
```php
$columns = [
'Name' => function($result) {
return $result->name;
},
'Registered At' => function($result) {
return $result->registered_at;
},
'Total Balance' => function($result) {
return $result->balance;
},
'Status' => function($result) { // You can do if statement or any action do you want inside this closure
return ($result->balance > 100000) ? 'Rich Man' : 'Normal Guy';
}
];
```
So you can do some **eager loading** like:
```php
$post = Post::with('comment')->where('active', 1);
$columns = [
'Post Title' => function($result) {
return $result->title;
},
'Slug' => 'slug',
'Top Comment' => function($result) {
return $result->comment->body;
}
];
```
### Output Report
### Example Code With Group By
Or, you can total all records by group using `groupBy` method
```php
...
// Do some querying..
$queryBuilder = User::select(['name', 'balance', 'registered_at'])
->whereBetween('registered_at', [$fromDate, $toDate])
->orderBy('registered_at', 'ASC'); // You should sort groupBy column to use groupBy() Method
// Set Column to be displayed
$columns = [
'Registered At' => 'registered_at',
'Name' => 'name',
'Total Balance' => 'balance',
'Status' => function($result) { // You can do if statement or any action do you want inside this closure
return ($result->balance > 100000) ? 'Rich Man' : 'Normal Guy';
}
];
return PdfReportGenerator::of($title, $meta, $queryBuilder, $columns)
->editColumn('Registered At', [
'displayAs' => function($result) {
return $result->registered_at->format('d M Y');
}
])
->editColumn('Total Balance', [
'class' => 'right bold',
'displayAs' => function($result) {
return thousandSeparator($result->balance);
}
])
->editColumn('Status', [
'class' => 'right bold',
])
->groupBy('Registered At')
->showTotal([
'Total Balance' => 'point'
])
->make()
->stream(); // or download() to download pdf
```
**PLEASE TAKE NOTE TO SORT GROUPBY COLUMN VIA QUERY FIRST TO USE THIS GROUP BY METHOD.**
### Output Report With Group By
## Other Method
### 1. setPaper($paper = 'a4')
**Description**: Set Paper Size
**Params**:
* $paper (Default: 'a4')
**Usage:**
```php
PdfReportGenerator::of($title, $meta, $queryBuilder, $columns)
->setPaper('a6')
->make();
```
### 2. setCss(Array $styles)
**Description**: Set a new custom styles with given selector and style to apply
**Params**:
* Array $styles (Key: $selector, Value: $style)
**Usage:**
```php
PdfReportGenerator::of($title, $meta, $queryBuilder, $columns)
->editColumn('Registered At', [
'class' => 'right bolder italic-red'
])
->setCss([
'.bolder' => 'font-weight: 800;',
'.italic-red' => 'color: red;font-style: italic;'
])
->make();
```
### 3. setOrientation($orientation = 'portrait')
**Description**: Set Orientation to Landscape or Portrait
**Params**:
* $orientation (Default: 'portrait')
**Usage:**
```php
PdfReportGenerator::of($title, $meta, $queryBuilder, $columns)
->setOrientation('landscape')
->make();
```