Documentation

PdfType
in package

A class defining a PDF data type

Table of Contents

Properties

$value  : mixed
The value of the PDF type.

Methods

flatten()  : PdfType
Flatten indirect object references to direct objects.
resolve()  : PdfType
Resolves a PdfType value to its value.
ensureType()  : mixed
Ensure that a value is an instance of a specific PDF type.

Properties

$value

The value of the PDF type.

public mixed $value

Methods

resolve()

Resolves a PdfType value to its value.

public static resolve(PdfType $value, PdfParser $parser[, bool $stopAtIndirectObject = false ][, array<string|int, mixed> &$ensuredObjectsList = [] ]) : PdfType

This method is used to evaluate indirect and direct object references until a final value is reached.

Parameters
$value : PdfType
$parser : PdfParser
$stopAtIndirectObject : bool = false
$ensuredObjectsList : array<string|int, mixed> = []

A list of all ensured indirect objects to prevent recursion

Tags
throws
CrossReferenceException
throws
PdfParserException
Return values
PdfType

ensureType()

Ensure that a value is an instance of a specific PDF type.

protected static ensureType(string $type, PdfType $value, string $errorMessage) : mixed
Parameters
$type : string
$value : PdfType
$errorMessage : string
Tags
throws
PdfTypeException

        
On this page

Search results