PHPackages aelian/make-pdf - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [PDF & Document Generation](/categories/documents) 4. / 5. aelian/make-pdf ActiveLibrary[PDF & Document Generation](/categories/documents) aelian/make-pdf =============== A simple way to make pdf documents and reports in PHP 09961PHP Since Oct 11Pushed 6mo agoCompare [ Source](https://github.com/aelian-repo/make-pdf)[ Packagist](https://packagist.org/packages/aelian/make-pdf)[ RSS](/packages/aelian-make-pdf/feed)WikiDiscussions master Synced 1w ago READMEChangelogDependenciesVersions (9)Used By (0) Make PDF ======== [](#make-pdf) A simple way to make pdf documents and reports in PHP. Getting Started --------------- [](#getting-started) These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. ### Prerequisites [](#prerequisites) ``` PHP 7.4.x. ``` ### Installing [](#installing) ``` composer require aelian/make-pdf ``` How it works ------------ [](#how-it-works) ### Simple document [](#simple-document) Instance a object PdfDocument: ``` use Pdf\MakePdf\PdfDocument; $document = new PdfDocument(); ``` Configure the document: ``` $settings = [ 'fileName' => 'hello_world.pdf', 'template' => [ 'body' => [ ['cell' => ['text' => 'Hello World!']], ], ], ]; ``` Create the document: ``` $document->create($settings); ``` ### Simple report [](#simple-report) Instance a object PdfReport: ``` use Pdf\MakePdf\PdfReport; $report = new PdfReport(); ``` Configure the report: ``` $settings = [ 'fileName' => 'report.pdf', 'template' => [ 'body' => [ ['line' => [ ['cell' => ['fieldName' => 'Aliance.number']], ['cell' => ['fieldName' => 'Aliance.name']] ]] ] ], 'records' => [ ['Aliance' => ['number' => 1, 'name' => 'Luke Skywalker']], ['Aliance' => ['number' => 2, 'name' => 'Leia Organa']], ]; ]; ``` Create the report: ``` $report->create($settings); ``` See more examples in [tests](tests) folder. Pdf Settings ------------ [](#pdf-settings) You can use these settings to customize your PDF document or report: - *fileName* - A complete path and file name to the generated PDF. Whether not defined, Make PDF will return a PDF content stream to be render in web browser. (Default null) - *outputType* - Destination where to send the document. It can be one of the following: I: send the file inline to the browser. The PDF viewer is used if available. D: send to the browser and force a file download with the name given by name. S: return the document as a string. (Default I) - *orientation* - PDF page orientation. Use 'P' to portrait or 'L' to landscape. (Default 'P') - *size* - PDF page size. Use A3, A4, A5, LETTER or LEGAL. (Default 'A4') - *records* - The data structure used to generate a PDF content, normaly feed from a database entity. In a PdfDocument each record will generate a page, although in PdfReport a page will contain many records acording with template defined options. ### Example of records: [](#example-of-records) ``` $records = [ ['EntityName' => ['fieldName' => 'Some content one']], ['EntityName' => ['fieldName' => 'Some content two']], ['EntityName' => ['fieldName' => 'Some content two']], ... ]; ``` - *skipFirstFooter* - Skips footer on first page. (Default false) - *configFields* - The dynamics configurations of cells that overcome template configuration. ### Example of configFields: [](#example-of-configfields) ``` $configFields = [ 'cell1' => ['lineHeight' => 10, 'text' => 'Hello world'], ... ]; ``` - *header* - A data structure like *records*, but contain only one record used in page header content. Defining PDF templates ---------------------- [](#defining-pdf-templates) A Template is a structure of options to customize your PDF document or report. Its formed by sessions, nodes and your respective attributes. All the elements are structured in a associative array. ### Sessions [](#sessions) The sessions are the regions will form your document: - *config* - The PDF defaults options will be used in entire document, like font size, alignment, border and margin. - *header* - The PDF page header options. - *columnTitles* - The PDF report column titles options. It will be printed just after *header*. - *body* - The document body or report detail options. This session is required to create the PDF. - *sumary* - The PDF sumary options, where reports will can be sumarized just after the *body* session. - *footer* - The PDF page footer options. It´s the last session to be printed. ### Nodes [](#nodes) The sessions contain a set of "nodes" to form the PDF page layout desired. Theses nodes can contain diferents behaviors, like: - *cell* - The simplest node. It behaves like a box where you can print some content. - *line* - Use to put one or more nodes in the same row. The nodes can be the same type or diferents. - *group* - Like *line* node a *group* is used to agroup many nodes, but it can contain many lines. - *title* - Use to describe a title of a node, by default its appear on the top of the node and with a minor font size than node. - *image* - Use to print a image. You can set the image size (width and height). - *checkbox* - It print a blank box to be checked, or fullfilled with some content. - *digit* - It print a sequence of boxes that can be used to set a field of a formulary. - *barCode123ABC* - It print a bar code of kind 123ABC. - *barCodeI25* - It print a bar code of kind I25. - *verse* - Use to define the content of a page verse. - *watermark* - It print a watermark in a PDF document or report. - *qrCodeImage* - Use to print a QR Code image in a PDF document or report. You can set the image size (width and height). - *PostNetCode* - It print a POSTNET bar code using a Zipcode. ### Attributes [](#attributes) The nodes can contain the follow attributes used to define its caracteristics: - *text* - A static content to be printed in a node. - *fieldName* - A dynamic content from *records* to be printed in a node. (example: Entity.field) - *border* - The border of a node. (0 - none, 1 - all, R - right, L - left, T - top and B - bottom) - *margin* - The left, right and top margin of the document or report page. Can be used only in *config* session. (Default 10 mm) - *align* - The content horizontal alignment. (L - left, C - center, R - right) - *title* - The node title content. It´s can be static (by attribute *text*) or dynamic (by attribute *fieldName*). - *fill* - A background color of a node (Use the RGB standard). - *alternateFill* - Alternate background color thru the lines using white and the color setted by alternateFill (Use the RGB standard). - *fontFamily* - The font family of a document or a node like Arial, Times, Courier, Symbol and ZapfDingbats. (Default Arial) - *fontStyle* - The font style of a document or a node. (B - bold, I - italic, N - normal, U - underscored) - *fontSizePt* - The font size of a document or a node. (Use points) - *textColor* - The text color of a document or a node. Use RGB string separating with commas. (Ex.: '100,150,200') - *titleFontFamily* - The font family of a node title like Arial, Times, Courier, Symbol and ZapfDingbats. (Default Arial) - *titleFontStyle* - The font style of a node title. (B - bold, I - italic, N - normal, U - underscored) - *titleFontSizePt* - The font size of a node title in points. - *lineWidth* - The width size of a node in milimiters. - *lineHeight* - The height size of a node in milimiters. - *x* - The horizontal position of a node in milimiters. - *y* - The vertical position of a node in milimiters. - *relativeX* - A offset in horizontal position of a node in milimiters. It can be a negative value. - *relativeY* - A offset in vertical position of a node in milimiters. It can be a negative value. - *groupSpacing* - A blank space after a printed group. - *decimal* - A double value format to print values. (Example: 1234.56 defined with "decimal = 2" results in "1.234,56" - *date* - A date value format to print dates. (Example: 2018-05-01 defined with "date = d/m/Y" results in "01/05/2018" - *autoPageBreak* - Set the bottom margin limit to page break automaticaly. - *footerPage* - Set a page for show the group. - *middlePage* - Set for show de group only in the middle of the page. - *autoLineBreak* - Set to break a line automaticaly when a text have the "\\n" caracter. - *useTag* - Set a cell to ajust font style when detect a tag in the content. Allowed tags are: `` - Bold, `` - Italic and `` - Underline - *configField* - Set a cell with configs found in *configFields* settings ### Example of a complete template contained sessions, nodes and attributes: [](#example-of-a-complete-template-contained-sessions-nodes-and-attributes) ``` $template = [ 'config' => [ 'border' => 1, 'align' => 'L', 'fill' => 0, 'fontFamily' => 'Arial', 'fontSizePt' => 10 ], 'header' => [ 'line1' => ['line' => [ 'lineHeight' => 20, 'image1' => ['image' => ['fieldName' => 'Header.image', 'lineWidth' => 20]], 'cell1' => ['cell' => ['fieldName' => 'Header.title']], ]], ], 'columnTitles' => [ 'line1' => ['line' => [ 'fontStyle' => 'B', 'cell1' => ['cell' => ['text' => 'Number', 'lineWidth' => 20]], 'cell2' => ['cell' => 'Name'], 'cell3' => ['cell' => ['text' => 'Value', 'lineWidth' => 30]], ]], ], 'body' => [ 'groupDetail1' => ['groupDetail' => [ 'fieldName' => 'Custumer.group', 'line1' => ['line' => [ 'lineHeight' => 10, 'fontSizePt' => 12, 'cell1' => ['cell' => ['text' => 'Group:', 'lineWidth' => 40, 'border' => 0]], 'cell2' => ['cell' => ['fieldName' => 'Custumer.group', 'border' => 0]], ]], ]], 'line1' => ['line' => [ 'lineHeight' => 10, 'alternateFill' => 210, 'border' => '1', 'cell1' => ['cell' => ['fieldName' => 'Custumer.number', 'lineWidth' => 20]], 'cell2' => ['cell' => ['fieldName' => 'Custumer.name']], 'cell3' => ['cell' => ['fieldName' => 'Custumer.value', 'lineWidth' => 30]], ]], ), 'sumary' => [ 'SUM_OF_CUSTUMER' => 'Custumer.value', 'line1' => ['line' => [ 'cell1' => ['cell' => ['text' => 'CUSTUMER COUNT ==> [RECORD_COUNT]', 'fontStyle' => 'I']], 'cell2' => ['cell' => ['text' => '[SUM_OF_CUSTUMER]', 'fontStyle' => 'B', 'decimal' => '2']], ]], ], 'footer' => [ 'line1' => ['line' => [ 'cell1' => ['cell' => 'Some footer text'], 'cell2' => ['cell' => 'In [DATE]'], 'cell3' => ['cell' => 'Pages: [PAGE]/[PAGES]'], ]], ], ]; ``` See more examples in [tests](tests) folder. ### Defining XML template files [](#defining-xml-template-files) Another good and easy way to set PDF templates is creating a XML files. Through a XML file you can keep the template rules isolated from your code, possibiliting dynamic genaration of templates. Use the option *templateFile* to define the complete path and XML file name. Example of a XML contained a template: ``` 1 C 0 Arial 20 2 250 1 6 Some text line 1 cell 3 20 1 Line title Some text line 2 cell 1 Some text line 2 cell 210 ``` It´s possible to set one or more XML files, using a array in "templateFile" option. Like: ``` $templateFile = [ '/templates/config.xml', '/templates/header.xml', '/templates/body.xml', '/templates/footer.xml' ]; ``` See more examples of template XML files in [tests/fixtures](tests/fixtures) folder. Built With ---------- [](#built-with) - [FPDF](http://www.fpdf.org/) - PHP class which allows to generate PDF files with pure PHP. - [PHP-QRCODE](https://github.com/chillerlan/php-qrcode) - A PHP QR Code library. Contributing ------------ [](#contributing) Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us. Versioning ---------- [](#versioning) We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/aelian-repo/make-pdf/tags). License ------- [](#license) This project is licensed under the Apache License - see the [LICENSE](LICENSE) file for details ### Health Score 29 — LowBetter than 59% of packages Maintenance47 Moderate activity, may be stable Popularity18 Limited adoption so far Community12 Small or concentrated contributor base Maturity32 Early-stage or recently created project Bus Factor1 Top contributor holds 90.3% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Community Maintainers ![](https://www.gravatar.com/avatar/f1a6726510ce93609b7b823e0cff4434352b8eb76039f6505540b8e9a2c05a83?d=identicon)[joacir](/maintainers/joacir) --- Top Contributors [![joacir](https://avatars.githubusercontent.com/u/342486?v=4)](https://github.com/joacir "joacir (84 commits)")[![DayaneMastelari](https://avatars.githubusercontent.com/u/41654313?v=4)](https://github.com/DayaneMastelari "DayaneMastelari (4 commits)")[![vica327001](https://avatars.githubusercontent.com/u/15736106?v=4)](https://github.com/vica327001 "vica327001 (3 commits)")[![Barbara-KCBS](https://avatars.githubusercontent.com/u/87725125?v=4)](https://github.com/Barbara-KCBS "Barbara-KCBS (1 commits)")[![RSayuri](https://avatars.githubusercontent.com/u/25225411?v=4)](https://github.com/RSayuri "RSayuri (1 commits)") ### Embed Badge ![Health badge](/badges/aelian-make-pdf/health.svg) ``` [![Health](https://phpackages.com/badges/aelian-make-pdf/health.svg)](https://phpackages.com/packages/aelian-make-pdf) ``` ### Alternatives [spatie/browsershot Convert a webpage to an image or pdf using headless Chrome 5.2k32.1M102](/packages/spatie-browsershot)[barryvdh/laravel-snappy Snappy PDF/Image for Laravel 2.8k24.8M48](/packages/barryvdh-laravel-snappy)[openspout/openspout PHP Library to read and write spreadsheet files (CSV, XLSX and ODS), in a fast and scalable way 1.2k57.6M131](/packages/openspout-openspout)[keboola/csv Keboola CSV reader and writer 1451.8M21](/packages/keboola-csv)[setasign/tfpdf This class is a modified version of FPDF that adds UTF-8 support. The latest version is based on FPDF 1.85. 426.1M30](/packages/setasign-tfpdf)[aspera/xlsx-reader Spreadsheet reader library for XLSX files 52742.2k5](/packages/aspera-xlsx-reader) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)