diff options
Diffstat (limited to 'vendor/setasign/fpdi/README.md')
| -rw-r--r-- | vendor/setasign/fpdi/README.md | 131 |
1 files changed, 131 insertions, 0 deletions
diff --git a/vendor/setasign/fpdi/README.md b/vendor/setasign/fpdi/README.md new file mode 100644 index 0000000..c503b7d --- /dev/null +++ b/vendor/setasign/fpdi/README.md @@ -0,0 +1,131 @@ +FPDI - Free PDF Document Importer +================================= + +[](https://packagist.org/packages/setasign/fpdi) +[](https://packagist.org/packages/setasign/fpdi) +[](https://packagist.org/packages/setasign/fpdi) +[](https://packagist.org/packages/setasign/fpdi) + +:heavy_exclamation_mark: This document refers to FPDI 2. Version 1 is deprecated and development is discontinued. :heavy_exclamation_mark: + +FPDI is a collection of PHP classes facilitating developers to read pages from existing PDF +documents and use them as templates in [FPDF](http://www.fpdf.org), which was developed by Olivier Plathey. Apart +from a copy of [FPDF](http://www.fpdf.org), FPDI does not require any special PHP extensions. + +FPDI can also be used as an extension for [TCPDF](https://github.com/tecnickcom/TCPDF) or +[tFPDF](http://fpdf.org/en/script/script92.php), too. + +## Installation with [Composer](https://packagist.org/packages/setasign/fpdi) + +Because FPDI can be used with FPDF, TCPDF or tFPDF we haven't added a fixed dependency in the main +composer.json file. You need to add the dependency to the PDF generation library of your choice +yourself. + +To use FPDI with FPDF include following in your composer.json file: + +```json +{ + "require": { + "setasign/fpdf": "1.8.*", + "setasign/fpdi": "^2.0" + } +} +``` + +If you want to use TCPDF, you have to update your composer.json to: + +```json +{ + "require": { + "tecnickcom/tcpdf": "6.3.*", + "setasign/fpdi": "^2.0" + } +} +``` + +If you want to use tFPDF, you have to update your composer.json to: + +```json +{ + "require": { + "setasign/tfpdf": "1.31.*", + "setasign/fpdi": "^2.3" + } +} +``` + +## Manual Installation + +If you do not use composer, just require the autoload.php in the /src folder: + +```php +require_once('src/autoload.php'); +``` + +If you have a PSR-4 autoloader implemented, just register the src path as follows: +```php +$loader = new \Example\Psr4AutoloaderClass; +$loader->register(); +$loader->addNamespace('setasign\Fpdi', 'path/to/src/'); +``` + +## Changes to Version 1 + +Version 2 is a complete rewrite from scratch of FPDI which comes with: +- Namespaced code +- Clean and up-to-date code base and style +- PSR-4 compatible autoloading +- Performance improvements by up to 100% +- Less memory consumption +- Native support for reading PDFs from strings or stream-resources +- Support for documents with "invalid" data before their file-header +- Optimized page tree resolving +- Usage of individual exceptions +- Several test types (unit, functional and visual tests) + +We tried to keep the main methods and logical workflow the same as in version 1 but please +notice that there were incompatible changes which you should consider when updating to +version 2: +- You need to load the code using the `src/autoload.php` file instead of `classes/FPDI.php`. +- The classes and traits are namespaced now: `setasign\Fpdi` +- Page boundaries beginning with a slash, such as `/MediaBox`, are not supported anymore. Remove + the slash or use a constant of `PdfReader\PageBoundaries`. +- The parameters $x, $y, $width and $height of the `useTemplate()` or `getTemplateSize()` + method have more logical correct default values now. Passing `0` as width or height will + result in an `InvalidArgumentException` now. +- The return value of `getTemplateSize()` had changed to an array with more speaking keys + and reusability: Use `width` instead of `w` and `height` instead of `h`. +- If you want to use **FPDI with TCPDF** you need to refactor your code to use the class `Tcpdf\Fpdi` +(since 2.1; before it was `TcpdfFpdi`) instead of `FPDI`. + +## Example and Documentation + +A simple example, that imports a single page and places this onto a new created page: + +```php +<?php +use setasign\Fpdi\Fpdi; +// or for usage with TCPDF: +// use setasign\Fpdi\Tcpdf\Fpdi; + +// or for usage with tFPDF: +// use setasign\Fpdi\Tfpdf\Fpdi; + +// setup the autoload function +require_once('vendor/autoload.php'); + +// initiate FPDI +$pdf = new Fpdi(); +// add a page +$pdf->AddPage(); +// set the source file +$pdf->setSourceFile("Fantastic-Speaker.pdf"); +// import page 1 +$tplId = $pdf->importPage(1); +// use the imported page and place it at point 10,10 with a width of 100 mm +$pdf->useTemplate($tplId, 10, 10, 100); + +$pdf->Output(); +``` + +A full end-user documentation and API reference is available [here](https://manuals.setasign.com/fpdi-manual/). |