setasign\Fpdi\PdfParser\Type

PdfArray Class representing a PDF array object

File: /FPDI v2/PdfParser/Type/PdfArray.php

Class hierarchy

Summary

Properties

$value

public mixed PdfType::$value

The value of the PDF type.


Static Methods

create()

public static PdfArray::create (
[ PdfType[] $values = array ( ) ]
): PdfArray

Helper method to create an instance.

Parameters
$values : PdfType[]
 

ensure()

public static PdfArray::ensure (
mixed $array [, null|int $size = null ]
): PdfArray

Ensures that the passed array is a PdfArray instance with a (optional) specific size.

Parameters
$array : mixed
 
$size : null|int
 
Exceptions

Throws PdfTypeException

ensureType()

protected static PdfType::ensureType (
string $type, PdfType $value, string $errorMessage
): mixed

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

Parameters
$type : string
 
$value : PdfType
 
$errorMessage : string
 
Exceptions

Throws PdfTypeException

flatten()

Flatten indirect object references to direct objects.

Parameters
$value : PdfType
 
$parser : \setasign\Fpdi\PdfParser\PdfParser
 
Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException

parse()

Parses an array of the passed tokenizer and parser.

Parameters
$tokenizer : \setasign\Fpdi\PdfParser\Tokenizer
 
$parser : \setasign\Fpdi\PdfParser\PdfParser
 
Exceptions

Throws PdfTypeException

resolve()

public static PdfType::resolve (
PdfType $value, \setasign\Fpdi\PdfParser\PdfParser $parser [, bool $stopAtIndirectObject = false ]
): PdfType

Resolves a PdfType value to its value.

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

Parameters
$value : PdfType
 
$parser : \setasign\Fpdi\PdfParser\PdfParser
 
$stopAtIndirectObject : bool
 
Exceptions

Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException

Throws \setasign\Fpdi\PdfParser\PdfParserException