Class setasign\Fpdi\Tcpdf\Fpdi in FPDI v2 API Reference

Index

\setasign\Fpdi
1. Tcpdf
  1. Fpdi

setasign\Fpdi\Tcpdf

Fpdi Class Fpdi

File: /FPDI v2/Tcpdf/Fpdi.php

This class let you import pages of existing PDF documents into a reusable structure for TCPDF.

Class hierarchy

TCPDF
- Fpdi
  - \setasign\Fpdi\TcpdfFpdi

Uses

\setasign\Fpdi\FpdiTrait

Summary

Constants

VERSION

public const Fpdi::VERSION = '2.6.0'

FPDI version

Properties

$createdReaders

protected array \setasign\Fpdi\FpdiTrait::$createdReaders = array()

Instances created internally.

$currentObjectNumber

protected int|null Fpdi::$currentObjectNumber

The currently used object number.

$currentReaderId

protected string|null \setasign\Fpdi\FpdiTrait::$currentReaderId

The current reader id.

$importedPages

protected array \setasign\Fpdi\FpdiTrait::$importedPages = array()

Data of all imported pages.

$objectMap

protected array \setasign\Fpdi\FpdiTrait::$objectMap = array()

A map from object numbers of imported objects to new assigned object numbers by FPDF.

$objectsToCopy

protected array \setasign\Fpdi\FpdiTrait::$objectsToCopy = array()

An array with information about objects, which needs to be copied to the resulting document.

$readers

protected \setasign\Fpdi\PdfReader\PdfReader[] \setasign\Fpdi\FpdiTrait::$readers = array()

The pdf reader instances.

$templateId

protected int Fpdi::$templateId = 0

A counter for template ids.

Methods

_enddoc()

protected Fpdi::_enddoc (

void

): void

_getxobjectdict()

protected Fpdi::_getxobjectdict (

void

): string

_newobj()

protected Fpdi::_newobj (

[ int|string $objid = '' ]

): int

Begin a new object and return the object number.

Parameters

$objid : int|string: Object ID (leave empty to get a new ID).

Return Values

object number

_put()

protected Fpdi::_put (

string $s [, bool $newLine = true ]

): void

Append content to the buffer of TCPDF.

Parameters

$s : string
$newLine : bool

_putxobjects()

protected Fpdi::_putxobjects (

void

): void

Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException

adjustLastLink()

protected Fpdi::adjustLastLink (

): void

This method will add additional data to the last created link/annotation.

It will copy styling properties (supported by TCPDF) of the imported link.

Parameters

$externalLink : array
$xPt : float|int
$scaleX : float|int
$yPt : float|int
$newHeightPt : float|int
$scaleY : float|int
$importedPage : array

cleanUp()

public \setasign\Fpdi\FpdiTrait::cleanUp (

[ bool $allReaders = false ]

): void

Release resources and file handles.

This method is called internally when the document is created successfully. By default it only cleans up stream reader instances which were created internally.

Parameters

$allReaders : bool

fpdiUseImportedPage()

public \setasign\Fpdi\FpdiTrait::fpdiUseImportedPage (

): array

Draws an imported page onto the page.

Give only one of the size parameters (width, height) to calculate the other one automatically in view to the aspect ratio.

Parameters

$pageId : mixed: The page id
$x : float|int|array: The abscissa of upper-left corner. Alternatively you could use an assoc array with the keys "x", "y", "width", "height", "adjustPageSize".
$y : float|int: The ordinate of upper-left corner.
$width : float|int|null: The width.
$height : float|int|null: The height.
$adjustPageSize : bool

Return Values

The size.

See

\setasign\Fpdi\Fpdi::getTemplateSize()

fpdiWritePdfType()

protected \setasign\Fpdi\FpdiTrait::fpdiWritePdfType (

\setasign\Fpdi\PdfParser\Type\PdfType $value

): void

Writes a PdfType object to the resulting buffer.

Parameters

$value : \setasign\Fpdi\PdfParser\Type\PdfType

Exceptions

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

getImportedPageSize()

public \setasign\Fpdi\FpdiTrait::getImportedPageSize (

mixed $tpl [, float|int|null $width = null [, float|int|null $height = null ]]

): array|bool

Get the size of an imported page.

Give only one of the size parameters (width, height) to calculate the other one automatically in view to the aspect ratio.

Parameters

$tpl : mixed: The template id
$width : float|int|null: The width.
$height : float|int|null: The height.

Return Values

An array with following keys: width, height, 0 (=width), 1 (=height), orientation (L or P)

getNextTemplateId()

protected Fpdi::getNextTemplateId (

void

): int

Get the next template id.

getPdfParserInstance()

protected \setasign\Fpdi\FpdiTrait::getPdfParserInstance (

\setasign\Fpdi\PdfParser\StreamReader $streamReader [, array $parserParams = array ( ) ]

): \setasign\Fpdi\PdfParser\PdfParser|\setasign\FpdiPdfParser\PdfParser\PdfParser

Get a new pdf parser instance.

Parameters

$streamReader : \setasign\Fpdi\PdfParser\StreamReader
$parserParams : array: Individual parameters passed to the parser instance.

getPdfReader()

protected \setasign\Fpdi\FpdiTrait::getPdfReader (

string $id

): \setasign\Fpdi\PdfReader\PdfReader

Get a pdf reader instance by its id.

Parameters

$id : string

getPdfReaderId()

protected \setasign\Fpdi\FpdiTrait::getPdfReaderId (

string|resource|\setasign\Fpdi\PdfReader\PdfReader|\setasign\Fpdi\PdfParser\StreamReader $file [, array $parserParams = array ( ) ]

): string

Get an unique reader id by the $file parameter.

Parameters

$file : string|resource|\setasign\Fpdi\PdfReader\PdfReader|\setasign\Fpdi\PdfParser\StreamReader: An open file descriptor, a path to a file, a PdfReader instance or a StreamReader instance.
$parserParams : array: Individual parameters passed to the parser instance.

getTemplateSize()

public Fpdi::getTemplateSize (

mixed $tpl [, float|int|null $width = null [, float|int|null $height = null ]]

): array|bool

Get the size of an imported page.

Give only one of the size parameters (width, height) to calculate the other one automatically in view to the aspect ratio.

Parameters

$tpl : mixed: The template id
$width : float|int|null: The width.
$height : float|int|null: The height.

Return Values

An array with following keys: width, height, 0 (=width), 1 (=height), orientation (L or P)

importPage()

public \setasign\Fpdi\FpdiTrait::importPage (

int $pageNumber [, string $box = \setasign\Fpdi\PdfReader\PageBoundaries ::CROP_BOX [, bool $groupXObject = true [, bool $importExternalLinks = false ]]]

): string

Imports a page.

Parameters

$pageNumber : int: The page number.
$box : string: The page boundary to import. Default set to PageBoundaries::CROP_BOX.
$groupXObject : bool: Define the form XObject as a group XObject to support transparency (if used).
$importExternalLinks : bool: Define whether external links are imported or not.

Return Values

A unique string identifying the imported page.

Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\Filter\FilterException

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

Throws \setasign\Fpdi\PdfReader\PdfReaderException

See

PageBoundaries

setMinPdfVersion()

protected \setasign\Fpdi\FpdiTrait::setMinPdfVersion (

string $pdfVersion

): void

Set the minimal PDF version.

Parameters

$pdfVersion : string

setSourceFile()

public \setasign\Fpdi\FpdiTrait::setSourceFile (

string|resource|\setasign\Fpdi\PdfParser\StreamReader $file

): int

Set the source PDF file.

Parameters

$file : string|resource|\setasign\Fpdi\PdfParser\StreamReader: Path to the file or a stream resource or a StreamReader instance.

Return Values

The page count of the PDF document.

Exceptions

Throws \setasign\Fpdi\PdfParser\PdfParserException

setSourceFileWithParserParams()

public \setasign\Fpdi\FpdiTrait::setSourceFileWithParserParams (

string|resource|\setasign\Fpdi\PdfParser\StreamReader $file [, array $parserParams = array ( ) ]

): int

Set the source PDF file with parameters which are passed to the parser instance.

This method allows us to pass e.g. authentication information to the parser instance.

Parameters

$file : string|resource|\setasign\Fpdi\PdfParser\StreamReader: Path to the file or a stream resource or a StreamReader instance.
$parserParams : array: Individual parameters passed to the parser instance.

Return Values

The page count of the PDF document.

Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException

useImportedPage()

public Fpdi::useImportedPage (

): array

Draws an imported page onto the page.

Give only one of the size parameters (width, height) to calculate the other one automatically in view to the aspect ratio.

Parameters

$pageId : mixed: The page id
$x : float|int|array: The abscissa of upper-left corner. Alternatively you could use an assoc array with the keys "x", "y", "width", "height", "adjustPageSize".
$y : float|int: The ordinate of upper-left corner.
$width : float|int|null: The width.
$height : float|int|null: The height.
$adjustPageSize : bool

Return Values

The size.

See

Fpdi::getTemplateSize()

useTemplate()

public Fpdi::useTemplate (

): array

Draws an imported page onto the page or another template.

Give only one of the size parameters (width, height) to calculate the other one automatically in view to the aspect ratio.

Parameters

$tpl : mixed: The template id
$x : float|int|array: The abscissa of upper-left corner. Alternatively you could use an assoc array with the keys "x", "y", "width", "height", "adjustPageSize".
$y : float|int: The ordinate of upper-left corner.
$width : float|int|null: The width.
$height : float|int|null: The height.
$adjustPageSize : bool

Return Values

The size

See

\setasign\Fpdi\Tcpdf\FpdiTrait::getTemplateSize()

writePdfType()

protected Fpdi::writePdfType (

\setasign\Fpdi\PdfParser\Type\PdfType $value

): void

Writes a PdfType object to the resulting buffer.

Parameters

$value : \setasign\Fpdi\PdfParser\Type\PdfType

Exceptions

Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException