Index

  1. \setasign\Fpdi
    1. PdfParser
      1. Type
        1. PdfArray
        2. PdfBoolean
        3. PdfDictionary
        4. PdfHexString
        5. PdfIndirectObject
        6. PdfIndirectObjectReference
        7. PdfName
        8. PdfNull
        9. PdfNumeric
        10. PdfStream
        11. PdfString
        12. PdfToken
        13. PdfType
        14. PdfTypeException

setasign\Fpdi\PdfParser\Type

PdfIndirectObject Class representing an indirect object

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

Class hierarchy

Summary

Static Methods

Properties

Properties

$generationNumber

public int PdfIndirectObject::$generationNumber

The generation number.

$objectNumber

public int PdfIndirectObject::$objectNumber

The object number.

$value

public mixed PdfType::$value

The value of the PDF type.


Static Methods

create()

public static PdfIndirectObject::create (
int $objectNumber,
int $generationNumber,
PdfType $value
): self

Helper method to create an instance.

Parameters
$objectNumber : int
 
$generationNumber : int
 
$value : PdfType
 

ensure()

public static PdfIndirectObject::ensure (
mixed $indirectObject
): self

Ensures that the passed value is a PdfIndirectObject instance.

Parameters
$indirectObject : mixed
 
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()

public static PdfType::flatten (): PdfType

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()

public static PdfIndirectObject::parse (
int $objectNumber,
int $objectGenerationNumber,
\setasign\Fpdi\PdfParser\PdfParser $parser,
\setasign\Fpdi\PdfParser\Tokenizer $tokenizer,
\setasign\Fpdi\PdfParser\StreamReader $reader
): self|false

Parses 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()

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


© 2025 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)