setasign\Fpdi\PdfParser\Type
PdfIndirectObject Class representing an indirect object
File: /FPDI v2/PdfParser/Type/PdfIndirectObject.php
Class hierarchy
Summary
Properties
$generationNumber
public int PdfIndirectObject::$generationNumber
The generation number.
$objectNumber
public int PdfIndirectObject::$objectNumber
The object number.
Static Methods
create()
Helper method to create an instance.
Parameters
- $objectNumber : int
- $generationNumber : int
- $value : PdfType
ensure()
Ensures that the passed value is a PdfIndirectObject instance.
Parameters
- $indirectObject : mixed
Exceptions
Throws PdfTypeException
ensureType()
Ensure that a value is an instance of a specific PDF type.
Parameters
- $type : string
- $value : PdfType
- $errorMessage : string
Exceptions
Throws PdfTypeException
flatten()
public static PdfType::flatten (
PdfType $value, \setasign\Fpdi\PdfParser\PdfParser $parser
): PdfTypeFlatten indirect object references to direct objects.
Parameters
- $value : PdfType
- $parser : \setasign\Fpdi\PdfParser\PdfParser
Exceptions
Throws \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
parse()
public static PdfIndirectObject::parse (
int $objectNumber, int $objectGenerationNumber, \setasign\Fpdi\PdfParser\PdfParser $parser, \setasign\Fpdi\PdfParser\Tokenizer $tokenizer, \setasign\Fpdi\PdfParser\StreamReader $reader
): PdfIndirectObject|falseParses an indirect object from a tokenizer, parser and stream-reader.
Parameters
- $objectNumber : int
- $objectGenerationNumber : int
- $parser : \setasign\Fpdi\PdfParser\PdfParser
- $tokenizer : \setasign\Fpdi\PdfParser\Tokenizer
- $reader : \setasign\Fpdi\PdfParser\StreamReader
Exceptions
Throws PdfTypeException
resolve()
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