https://github.com/elibyy/tcpdf-laravel

TCPDF helper for laravel
https://github.com/elibyy/tcpdf-laravel

laravel pdf php

Last synced: 7 days ago
JSON representation

TCPDF helper for laravel

• Host: GitHub
• URL: https://github.com/elibyy/tcpdf-laravel
• Owner: elibyy
• License: mit
• Created: 2016-02-10T21:07:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-03-26T07:50:37.000Z (8 months ago)
• Last Synced: 2024-09-08T05:54:23.542Z (about 2 months ago)
• Topics: laravel, pdf, php
• Language: PHP
• Size: 93.8 KB
• Stars: 301
• Watchers: 13
• Forks: 74
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Laravel 6-7-8-9-10-11 TCPDF

[![Latest Stable Version](https://poser.pugx.org/elibyy/tcpdf-laravel/v/stable)](https://packagist.org/packages/elibyy/tcpdf-laravel) [![Total Downloads](https://poser.pugx.org/elibyy/tcpdf-laravel/downloads)](https://packagist.org/packages/elibyy/tcpdf-laravel) [![Latest Unstable Version](https://poser.pugx.org/elibyy/tcpdf-laravel/v/unstable)](https://packagist.org/packages/elibyy/tcpdf-laravel) [![License](https://poser.pugx.org/elibyy/tcpdf-laravel/license)](https://packagist.org/packages/elibyy/tcpdf-laravel)

A simple [Laravel](http://www.laravel.com) service provider with some basic configuration for including the [TCPDF library](http://www.tcpdf.org/)

#### TCPDF is not really supported in PHP 7 but there's a plan for supporting it, check [this](https://github.com/tecnickcom/tc-lib-pdf) out.

## Installation

The Laravel TCPDF service provider can be installed via [composer](http://getcomposer.org) by requiring the `elibyy/tcpdf-laravel` package in your project's `composer.json`. (The installation may take a while, because the package requires TCPDF. Sadly its .git folder is very heavy)

```

composer require elibyy/tcpdf-laravel

```

or

Laravel 5.5+ will use the auto-discovery function.

```json

{

    "require": {

        "elibyy/tcpdf-laravel": "^9.0"

    }

}

```

If you don't use auto-discovery you will need to include the service provider / facade in `config/app.php`.

```php

'providers' => [

    //...

    Elibyy\TCPDF\ServiceProvider::class,

]

//...

'aliases' => [

    //...

    'PDF' => Elibyy\TCPDF\Facades\TCPDF::class

]

```

(Please note: TCPDF cannot be used as an alias)

for lumen you should add the following lines:

```php

$app->register(Elibyy\TCPDF\ServiceProvider::class);

class_alias(Elibyy\TCPDF\Facades\TCPDF::class, 'PDF');

```

That's it! You're good to go.

Here is a little example:

```php

use PDF; // at the top of the file

  PDF::SetTitle('Hello World');

  PDF::AddPage();

  PDF::Write(0, 'Hello World');

  PDF::Output('hello_world.pdf');

```

another example for generating multiple PDF's

```php

use PDF; // at the top of the file

  for ($i = 0; $i < 5; $i++) {

    PDF::SetTitle('Hello World'.$i);

    PDF::AddPage();

    PDF::Write(0, 'Hello World'.$i);

    PDF::Output(public_path('hello_world' . $i . '.pdf'), 'F');

    PDF::reset();

  }

```

For a list of all available function take a look at the [TCPDF Documentation](http://www.tcpdf.org/doc/code/classTCPDF.html)

## Configuration

Laravel-TCPDF comes with some basic configuration.

If you want to override the defaults, you can publish the config, like so:

    php artisan vendor:publish --provider="Elibyy\TCPDF\ServiceProvider"

Now access `config/tcpdf.php` to customize.

 * use_original_header is to used the original `Header()` from TCPDF.

    * Please note that `PDF::setHeaderCallback(function($pdf){})` overrides this settings.

 * use_original_footer is to used the original `Footer()` from TCPDF.

    * Please note that `PDF::setFooterCallback(function($pdf){})` overrides this settings.

 * use_fpdi is so that our internal helper will extend `TcpdfFpdi` instead of `TCPDF`.

    * Please note fpdi is not a dependency in my project so you will have to follow their install instructions [here](https://github.com/Setasign/FPDI)

## Header/Footer helpers

I've got a pull-request asking for this so I've added the feature

now you can use `PDF::setHeaderCallback(function($pdf){})` or `PDF::setFooterCallback(function($pdf){})`