Index

  1. \setasign\SetaPDF2
    1. Core
      1. Type
        1. AbstractType
        2. BypassSecHandlerInterface
        3. Dictionary
        4. Exception
        5. IndirectObjectInterface
        6. IndirectReference
        7. OwnerInterface
        8. PdfArray
        9. PdfBoolean
        10. PdfCallback
        11. PdfDictionary
        12. PdfHexString
        13. PdfIndirectObject
        14. PdfIndirectReference
        15. PdfName
        16. PdfNull
        17. PdfNumeric
        18. PdfObjectStream
        19. PdfRaw
        20. PdfScalarValueInterface
        21. PdfStream
        22. PdfString
        23. PdfStringInterface
        24. PdfToken

setasign\SetaPDF2\Core\Type

PdfIndirectReference Class representing an indirect reference

File: /SetaPDF v2/Core/Type/PdfIndirectReference.php
Old class name (alias): \SetaPDF_Core_Type_IndirectReference

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_gen

protected int PdfIndirectReference::$_gen = 0

The initial generation number

$_objectId

protected int PdfIndirectReference::$_objectId

The initial object id

$_objectIdent

protected string PdfIndirectReference::$_objectIdent

The object identifier

$_observed

protected bool AbstractType::$_observed = false

Defines if this object is under observation

$_observers

protected array AbstractType::$_observers = array()

The Objects to notify on any change

This will be the PDF document or another value holding this one. Initially this will be an array.

$_owner

protected \SetaPDF_Core_Type_Owner PdfIndirectReference::$_owner

The owner instance

$metadata

public array AbstractType::$metadata = array()

An array for individual metadata.


Static Methods

_ensureType()

protected static AbstractType::_ensureType (
string $type,
mixed $value,
string $errorMessage,
$ensure = true
): mixed

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

Parameters
$type : string
 
$value : mixed
 
$errorMessage : string
 
$ensure
 
Exceptions

Throws Exception

ensureType()

public static PdfIndirectReference::ensureType (
mixed $value
): self

Ensures that the passed value is a PdfIndirectReference instance.

Parameters
$value : mixed
 
Exceptions

Throws Exception

ensureWithType()

public static AbstractType::ensureWithType (
string $type,
mixed $value
): \SetaPDF_Core_Type_AbstractType

Ensures that the passed value is an instance of the passed type.

Parameters
$type : string
 
$value : mixed
 
Exceptions

Throws Exception

is()

public static AbstractType::is (
string $type,
mixed $value,
bool $ensure = true
): bool

Checks if the type of a value is the expected one.

Indirect references will be evaluated if $ensure is set to true.

Parameters
$type : string
 
$value : mixed
 
$ensure : bool
 

writePdfString()

public static AbstractType::writePdfString (
\SetaPDF_Core_WriteInterface $writer,
mixed $value
): void

Parses a php value to a pdf string and writes it into a writer.

PHP data type -> PDF data type

Null -> PdfNull

Boolean -> PdfBoolean

Integer/Double -> PdfNumeric

String -> PdfString or PdfName(if the string starts with "/")

Indexed array -> PdfArray

Associative array -> PdfDictionary

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$value : mixed
 
Exceptions

Throws \InvalidArgumentException


Methods

__construct()

public PdfIndirectReference::__construct (
int|\SetaPDF_Core_Type_IndirectObjectInterface $objectId,
int $gen = 0,
?\SetaPDF_Core_Type_Owner $owner = null
)

The constructor.

Parameters
$objectId : int|\SetaPDF_Core_Type_IndirectObjectInterface
 
$gen : int
 
$owner : ?\SetaPDF_Core_Type_Owner
 
Exceptions

Throws \InvalidArgumentException

__clone()

public AbstractType::__clone (
void
): void

Implementation of __clone().

__sleep()

public AbstractType::__sleep (
void
): array

Implementation of __sleep.

We remove the observers from all elements because they will get read if they are waked up in an observed object.

__wakeup()

public AbstractType::__wakeup (
void
): void

Implementation of __wakeup.

Unset the observed flag.

attach()

public AbstractType::attach (
\SplObserver $observer
): void

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : \SplObserver
 

cleanUp()

public PdfIndirectReference::cleanUp (
void
): void

Release objects/memory.

See

deepClone()

public PdfIndirectReference::deepClone (): \SetaPDF_Core_Type_AbstractType

Clone the object recursively in the context of a document.

Parameters
$document : \SetaPDF_Core_Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

detach()

public AbstractType::detach (
\SplObserver $observer
): void

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters
$observer : \SplObserver
 

detachAll()

public AbstractType::detachAll (
void
): void

Detach all observers from this object.

Be careful with this method!!!

ensure()

public PdfIndirectReference::ensure (
bool $forceObservation = null,
array &$ensuredObjectsList = array ( )
): \SetaPDF_Core_Type_AbstractType

Automatically resolves the indirect reference to the object.

The $forceObservation is used to forward/handle the observer pattern.

If it is set to true or this object is observed already the resolved object will get observed automatically.

If the parameter is set to false, the document is detached from the resolved object, so that it is only possible to use this object as a read only object.

Parameters
$forceObservation : bool

If this is set to true, the resolved object will be observed automatically

$ensuredObjectsList : array

A list of all ensured indirect objects to prevent recursion

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws Exception

Throws IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

getGen()

public PdfIndirectReference::getGen (
void
): int

Returns the initial generation number.

getObjectId()

public PdfIndirectReference::getObjectId (
void
): int

Returns the initial object id.

getObjectIdent()

public PdfIndirectReference::getObjectIdent (
void
): string

Get the Object Identifier.

This identifier has nothing to do with the object numbers of a PDF document. They will be used to map an object to document related object numbers.

getOwner()

public PdfIndirectReference::getOwner (
void
): \SetaPDF_Core_Type_Owner

Get the owner object of this indirect object.

getOwnerPdfDocument()

public PdfIndirectReference::getOwnerPdfDocument (
void
): \SetaPDF_Core_Document

Returns the owner document.

getValue()

public PdfIndirectReference::getValue (
void
): ?\SetaPDF_Core_Type_IndirectObject

Get the indirect object.

Exceptions

Throws \setasign\SetaPDF2\Core\Document\ObjectNotFoundException

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Parser\Pdf\InvalidTokenException

Throws \setasign\SetaPDF2\Core\Reader\Exception

Throws Exception

Throws IndirectReference\Exception

Throws \setasign\SetaPDF2\Exception

Throws \setasign\SetaPDF2\NotImplementedException

isObserved()

public AbstractType::isObserved (
void
): bool

Checks if this object is observed.

notify()

public AbstractType::notify (
void
): void

Notifies all attached observers.

Implementation of the Observer Pattern.

Has to be called by any method that changes a value.

setValue()

public PdfIndirectReference::setValue (): void

Set the indirect object value.

Parameters
$value : \SetaPDF_Core_Type_IndirectObject
 
Exceptions

Throws \InvalidArgumentException

toPdfString()

public PdfIndirectReference::toPdfString (
?\SetaPDF_Core_Document $pdfDocument = null
): string

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : ?\SetaPDF_Core_Document
 

toPhp()

public PdfIndirectReference::toPhp (
void
): array

Converts the PDF data type to a PHP data type and returns it.

See

writeTo()

public PdfIndirectReference::writeTo (
\SetaPDF_Core_Document $pdfDocument
): void

Writes the type as a formatted PDF string to the document.

Parameters
$pdfDocument : \SetaPDF_Core_Document
 
Exceptions

Throws \setasign\SetaPDF2\Core\Exception


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