lianhua/superpdf

This package is abandoned and no longer maintained. No replacement package was suggested.

A simple library to manipulate PDF files

1.1.5 2023-11-07 06:14 UTC

Requires

• setasign/fpdf: ^1.8
• setasign/fpdi: ^2.3
• setasign/tfpdf: ^1.32
• tecnickcom/tcpdf: ^6.3

Requires (Dev)

• phpunit/phpunit: ^9.1
• squizlabs/php_codesniffer: ^3.5

GPL-3.0

• Camille Nevermind

README

A simple library to manipulate PDF files

Overview

A simple library to manipulate PDF files in PHP

Compatibility

This library has been tested for PHP 7.3 and higher. Functions relying on TCPDF don't work on PHP 8 at the moment!

Installation

Just use composer in your project:

composer require lianhua/superpdf

If you don't use composer, clone or download this repository, all you need is inside the src directory, you'll need the FPDI library.

Usage

Open a PDF file

You can open a PDF document with a new SuperPDF:

$pdf = new SuperPDF("/path/to/pdf/file");

Count the pages

You can ask for the pages count:

$pagesCount = $pdf->getPageCount();

Extract pages

Range

If you want to extract a range of pages into a pdf file:

$pdf->extractPageRange(3, 7, "path/to/pdf/output");

List

If you want to extract a list of pages into a pdf file:

$pdf->extractPageList([1, 3, 6, 8, 9], "path/to/pdf/output");

Insert a PDF document

If you want to insert a PDF file's contents into the document:

$pdf->insertPages("/path/to/pdf/to/insert", 5); // Inserts the PDF at page 5
$pdf->insertPages("/path/to/pdf/to/insert", SuperPDF::AFTER_EACH_PAGE); // Inserts the PDF after each page
$pdf->insertPages("/path/to/pdf/to/insert", SuperPDF::AFTER_ODD_PAGES); // Inserts the PDF after odd pages
$pdf->insertPages("/path/to/pdf/to/insert", SuperPDF::AFTER_EVEN_PAGES); // Inserts the PDF after even pages
$pdf->insertPages("/path/to/pdf/to/insert", SuperPDF::AT_THE_END); // Inserts the PDF after the last page

If you don't want to overwrite the document, you can give an output path:

$pdf->insertPages("/path/to/pdf/to/insert", 5, "/path/to/output");

Add a background

If you want to add a background on your document:

$pdf->addBackground("/path/to/background/pdf", 5); // Adds a background on page 5
$pdf->addBackground("/path/to/background/pdf", SuperPDF::ON_LAST_PAGE); // Adds a background on last page
$pdf->addBackground("/path/to/background/pdf", SuperPDF::ON_ODD_PAGES); // Adds a background on odd pages
$pdf->addBackground("/path/to/background/pdf", SuperPDF::ON_EVEN_PAGES); // Adds a background on even pages
$pdf->addBackground("/path/to/background/pdf", SuperPDF::ON_EACH_PAGE); // Adds a background on each page

Like before, if you don't want to overwrite the document, you can give an output path:

$pdf->addBackground("/path/to/background/pdf", 5, "/path/to/output");

Write text

If you want to write som text on the document:

$params = [
    "font" => "arial", // Font family
    "color" => ["r" => 30, "g" => 30, "b" => 30], // Font color
    "pos" => ["x" => 10, "y" => 20], // Text position
    "size" => 15 // Font size
];

$pdf->writeText("Some text", $params, 5); // Writes a text on page 5
$pdf->writeText("Some text", $params, SuperPDF::ON_LAST_PAGE); // Writes a text on last page
$pdf->writeText("Some text", $params, SuperPDF::ON_ODD_PAGES); // Writes a text on odd pages
$pdf->writeText("Some text", $params, SuperPDF::ON_EVEN_PAGES); // Writes a text on even pages
$pdf->writeText("Some text", $params, SuperPDF::ON_EACH_PAGE); // Writes a text on each page

Like before, if you don't want to overwrite the document, you can give an output path:

$pdf->writeText("Some text", $params, 5, "/path/to/output");

Draw an image

If you want to draw an image (PNG, JPG, GIF or SVG) on the document:

$params = [
    "x" => 30, // The X position
    "y" => 50, // The Y position
    "w" => 60 // The width (you can also use h)
];

$pdf->drawImage("/path/to/image/file", $params, 5); // Draws an image on page 5
$pdf->drawImage("/path/to/image/file", $params, SuperPDF::ON_LAST_PAGE); // Draws an image on last page
$pdf->drawImage("/path/to/image/file", $params, SuperPDF::ON_ODD_PAGES); // Draws an image on odd pages
$pdf->drawImage("/path/to/image/file", $params, SuperPDF::ON_EVEN_PAGES); // Draws an image on even pages
$pdf->drawImage("/path/to/image/file", $params, SuperPDF::ON_EACH_PAGE); // Draws an image on each page

Like before, if you don't want to overwrite the document, you can give an output path:

$pdf->drawImage("/path/to/image/file", $params, 5, "/path/to/output");