Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Type
        1. Dictionary
        2. Dictionary
        3. IndirectReference
        4. IndirectReference
        5. AbstractType
        6. Array
        7. Boolean
        8. BypassSecHandlerInterface
        9. Callback
        10. Exception
        11. HexString
        12. IndirectObject
        13. IndirectObjectInterface
        14. Name
        15. Null
        16. Numeric
        17. ObjectStream
        18. Owner
        19. Raw
        20. ScalarValue
        21. Stream
        22. String
        23. StringValue
        24. Token

SetaPDF_Core_Type_IndirectObject Class representing an indirect object

File: /SetaPDF v2/Core/Type/IndirectObject.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_gen

protected integer SetaPDF_Core_Type_IndirectObject::$_gen = 0

The initial generation number

$_objectId

protected int SetaPDF_Core_Type_IndirectObject::$_objectId

The initial object id

$_objectIdent

protected string SetaPDF_Core_Type_IndirectObject::$_objectIdent

The object identifier

$_observed

protected bool SetaPDF_Core_Type_AbstractType::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_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 SetaPDF_Core_Type_IndirectObject::$_owner

The owner object

$_value

protected SetaPDF_Core_Type_AbstractType SetaPDF_Core_Type_IndirectObject::$_value

The value of the indirect object

$metadata

public array SetaPDF_Core_Type_AbstractType::$metadata = array()

An array for individual metadata.


Static Methods

_ensureType()

protected static SetaPDF_Core_Type_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 SetaPDF_Core_Type_Exception

ensureType()

public static SetaPDF_Core_Type_IndirectObject::ensureType (
mixed $indirectObject
): SetaPDF_Core_Type_IndirectObject

Ensures that the passed value is a SetaPDF_Core_Type_IndirectObject instance.

Parameters
$indirectObject : mixed
 
Exceptions

Throws SetaPDF_Core_Type_Exception

ensureWithType()

public static SetaPDF_Core_Type_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 SetaPDF_Core_Type_Exception

is()

public static SetaPDF_Core_Type_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 SetaPDF_Core_Type_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 -> SetaPDF_Core_Type_Null

Boolean -> SetaPDF_Core_Type_Boolean

Integer/Double -> SetaPDF_Core_Type_Numeric

String -> SetaPDF_Core_Type_String or SetaPDF_Core_Type_Name(if the string starts with "/")

Indexed array -> SetaPDF_Core_Type_Array

Associative array -> SetaPDF_Core_Type_Dictionary

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value : mixed
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Type_IndirectObject::__construct (
[ null|SetaPDF_Core_Type_AbstractType $value = null [, SetaPDF_Core_Type_Owner $owner = null [, integer $objectId = 0 [, integer $gen = 0 ]]]]
)

The constructor.

Parameters
$value : null|SetaPDF_Core_Type_AbstractType
 
$owner : SetaPDF_Core_Type_Owner
 
$objectId : integer
 
$gen : integer
 
Exceptions

Throws InvalidArgumentException

attach()

public SetaPDF_Core_Type_IndirectObject::attach (
SplObserver $observer
): void

Add an observer to the object.

Implementation of the Observer Pattern. This overwritten method forwards the attach()-call to the value of the indirect object.

Parameters
$observer : SplObserver
 

cleanUp()

public SetaPDF_Core_Type_IndirectObject::cleanUp (
void
): void

Release objects/memory.

See

deepClone()

public SetaPDF_Core_Type_IndirectObject::deepClone (): SetaPDF_Core_Type_AbstractType

Clone the object recursively in the context of a document.

Parameters
$document : SetaPDF_Core_Document
 

detach()

public SetaPDF_Core_Type_AbstractType::detach (
SplObserver $observer
): void

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

detachAll()

public SetaPDF_Core_Type_AbstractType::detachAll (
void
): void

Detach all observers from this object.

Be careful with this method!!!

ensure()

public SetaPDF_Core_Type_IndirectObject::ensure (
[ boolean|null $forceObservation = null ]
): SetaPDF_Core_Type_AbstractType

Ensures the access to the value.

This method automatically forwards the request to the value.

Parameters
$forceObservation : boolean|null
 

getGen()

public SetaPDF_Core_Type_IndirectObject::getGen (
void
): integer

Returns the initial generation number.

getObjectId()

public SetaPDF_Core_Type_IndirectObject::getObjectId (
void
): integer

Returns the initial object id.

getObjectIdent()

public SetaPDF_Core_Type_IndirectObject::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 SetaPDF_Core_Type_IndirectObject::getOwner (
void
): SetaPDF_Core_Type_Owner

Get the owner object of this indirect object.

getOwnerPdfDocument()

public SetaPDF_Core_Type_IndirectObject::getOwnerPdfDocument (
void
): SetaPDF_Core_Document

Returns the owner document.

getValue()

public SetaPDF_Core_Type_IndirectObject::getValue (
void
): SetaPDF_Core_Type_AbstractType

Gets the PDF value.

isObserved()

public SetaPDF_Core_Type_AbstractType::isObserved (
void
): bool

Checks if this object is observed.

notify()

public SetaPDF_Core_Type_AbstractType::notify (
void
): void

Notifies all attached observers.

Implementation of the Observer Pattern.

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

observe()

public SetaPDF_Core_Type_IndirectObject::observe (
void
): void

Observe the object if an owner document is attached.

setValue()

public SetaPDF_Core_Type_IndirectObject::setValue (): void

Sets the value of the PDF type.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

toPdfString()

public SetaPDF_Core_Type_IndirectObject::toPdfString (
[ SetaPDF_Core_Document $pdfDocument = null ]
): string

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public SetaPDF_Core_Type_IndirectObject::toPhp (
void
): array

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

See

update()

public SetaPDF_Core_Type_IndirectObject::update (
SplSubject $SplSubject
): void

Triggered if a value of this object is changed.

Forward this to other observing objects.

Parameters
$SplSubject : SplSubject
 

writeTo()

public SetaPDF_Core_Type_IndirectObject::writeTo (
SetaPDF_Core_Document $pdfDocument
): void

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

Parameters
$pdfDocument : SetaPDF_Core_Document
 

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