README

Introduction

Papier is a low-level PHP library for generating PDF files. It implements the ISO 32000-1 standard.

Why not use FPDF or TCPDF?

Although these are excellent libraries, they don't allow you to use the many features offered by the PDF format.

What can be done with Papier ?

The library is growing every day; for the moment Papier can be used to write texts, draw shapes and display images and graphics. Papier supports the following:

JPEG and PNG with transparency images.
RGB and CMYK colors spaces for texts.
Texts and images can be transformed (rotation, translation, skew).
True type fonts are supported.

Installation

You can install Papier via composer using:

composer require papier/papier

Example usage

use Papier\Papier;
use Papier\Factory\Factory;
use Papier\Graphics\DeviceColourSpace;
use Papier\Text\Encoding;
use Papier\Text\RenderingMode;

require __DIR__.'/vendor/autoload.php';

$pathToLocalFontFile = 'Lato-Regular.ttf';
$pathToLocalImage = 'test.png';

$pdf = new Papier();
$pdf->getHeader()->setVersion(7);

$page = $pdf->addPage([210, 297]);
$image = $pdf->addImageComponent()->setPage($page);
$image->setSource($pathToLocalImage);
$image->setWidth(50);
$image->translate(10, 10);


$font = Factory::create('Papier\Type\TrueTypeFontDictionaryType', null, true);
$font->load($pathToLocalFontFile);
$font->setEncoding(Encoding::WIN_ANSI);

$page = $pdf->addPage([210, 297]);

$text = $pdf->addTextComponent();
$text->setNonStrokingColor(1, 0, 0);
$text->setStrokingColor(0, 1, 0);
$text->setNonStrokingColorSpace(DeviceColourSpace::RGB);
$text->setStrokingColorSpace(DeviceColourSpace::RGB);
$text->setRenderingMode(RenderingMode::FILL_THEN_STROKE);
$text->setText('Café');
$text->setFont($font);
$text->setFontSize(12);
$text->translate(100, 100);
$text->setWidth(100);
$text->setTextAlign(\Papier\Text\TextAlign::CENTER);

$boundingBox = $text->getBoundingBox();

$rect = $pdf->addRectangleComponent()->setPage($page);
$rect->setStrokingColor(0.9, 0, 0);
$rect->setStrokingColorSpace(DeviceColourSpace::RGB);
$rect->setXY($boundingBox[0], $boundingBox[1]);
$rect->setWidth($boundingBox[2]);
$rect->setHeight($boundingBox[3]);

$annot = $pdf->addTextAnnotation($page);
$annot->setContents('Hello World !');
$annot->setRect([50, 50, 70, 100]);
$annot->setT('Mikael');
$annot->setOpen(true);

$page = $pdf->addPage([210, 297]);

$draw = $pdf->addDrawComponent()->setPage($page);
$draw->setNonStrokingColor(0.4, 0, 0.4);
$draw->setStrokingColor(0.9, 0, 0);
$draw->setStrokingColorSpace(DeviceColourSpace::RGB);
$draw->setNonStrokingColorSpace(DeviceColourSpace::RGB);
$draw->addPoint(50, 50);
$draw->addPointWithControlPoints(150, 5, 74, 120, 150, 150);
$draw->addPoint(200, 200);

$pageLabels = $pdf->getPageLabels();
$pageLabels->addLabel(0, \Papier\Document\NumberingStyle::LOWERCASE_ROMAN);

$info = $pdf->getInfo();
$info->setTitle('Papier');
$info->setAuthor('Mikaël Carlavan');

$viewer = $pdf->getViewerPreferences();
$viewer->setDisplayDocTitle(true);

$pdf->save('test.pdf');

More examples can be found in the examples directory.

License

Papier is open-sourced software licensed under the MIT license.

papier / papier

Maintainers

Details