README

PDF documents from PHP, with real fonts, and nothing to install beside it.

phil/paged-media writes PDF files and works on them. Its native writer places text, lines, rectangles, images and fillable form fields on pages of any size, in the standard Helvetica fonts or in a TrueType font it embeds, reduced to the glyphs the document prints, so a receipt, a ticket or a printable sheet can be written in any script; its printed templates draw name badges, labels, gift and download cards, calendars and large-print editions from data. Its Gotenberg client sends PDFs to a Gotenberg 9 service to merge, split, stamp, fill, redact, tag, encrypt, sign and timestamp them, to make them PDF/A, PDF/UA or Factur-X and check that they are, to read their information, and to convert office documents with LibreOffice. It does not lay out HTML or CSS: that is the job of a paged-media engine, for which its PageRule writes the @page rule of a printed page, with its bleed and printer's marks.

It is for any PHP code that must produce a PDF: invoices and receipts, tickets, labels, certificates and reports with the native writer alone, with no browser, binary or service; archived, accessible, signed or e-invoicing documents, and documents written in an office suite, through Gotenberg. phil/commerce-bundle prints its receipts with it.

It is a plain PHP library. The native writer requires only ext-ctype, ext-mbstring and ext-zlib, and its output is deterministic: the same calls give the same bytes, which makes documents comparable and testable. The Gotenberg client speaks through Symfony HttpClient, a suggested dependency, and checks every request before it is sent — a stage's options, the order of a list of stages, the addresses Gotenberg fetches, read by phil/url — so a request Gotenberg would refuse is never sent.

Status

Documentation

Quick start

composer require phil/paged-media

use Phil\PagedMedia\Font\StandardFont;
use Phil\PagedMedia\Font\TrueTypeFont;
use Phil\PagedMedia\Pdf\Color;
use Phil\PagedMedia\Pdf\Document;
use Phil\PagedMedia\Pdf\Metadata;
use Phil\PagedMedia\Pdf\PageSize;

$font = TrueTypeFont::fromFile('/path/to/NotoSans-Regular.ttf');

$pdf = new Document(PageSize::a5(), new Metadata(title: 'Ticket'));
$pdf->addPage();
$pdf->text(36, 540, 'Admit one', 18, StandardFont::HelveticaBold);
$pdf->text(36, 515, 'Élise Tremblay — 東京', 12, $font);
$pdf->line(36, 505, 384, 505, 0.5, Color::gray(128));
$pdf->textRight(384, 480, '12,50 $', 12, $font);

file_put_contents('ticket.pdf', $pdf->render());

Through Gotenberg, the same ticket archived and signed:

use Phil\PagedMedia\Gotenberg\Files;
use Phil\PagedMedia\Gotenberg\Gotenberg;
use Phil\PagedMedia\Gotenberg\InputFile;
use Phil\PagedMedia\Gotenberg\Pipeline;
use Phil\PagedMedia\Gotenberg\Profile;
use Phil\PagedMedia\Gotenberg\Signing\FileCertificateSource;
use Phil\PagedMedia\Gotenberg\Stage\Remediate;
use Phil\PagedMedia\Gotenberg\Stage\Sign;
use Symfony\Component\HttpClient\HttpClient;

$gotenberg = new Gotenberg(HttpClient::create(), 'http://gotenberg:3000');

$result = $gotenberg->pipe(
    Files::of(InputFile::fromDocument('ticket.pdf', $pdf)),
    new Pipeline(new Remediate(Profile::PdfA3b), Sign::with(new FileCertificateSource('/run/secrets/signer.p12', null, $password))),
);
$result->saveTo('ticket.pdf');   // $result->residual === 0: it conforms

Requirements

PHP 8.5 or later with ext-ctype, ext-mbstring, ext-uri and ext-zlib, and phil/url; Symfony HttpClient and a Gotenberg 9 service for the Gotenberg client. See Installation.

Contributing

Contributions are welcome on the PHIL monorepo: read the contribution guide and the code of conduct. Report a vulnerability privately, as the security policy explains, never in a public issue.

License

MIT, © Philippe Gamache, doing business as Le Gnome Archiviste; a Parler Haut Interagir Librement project. See LICENSE.