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

PdfDictionary Class representing a dictionary

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

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_entries

protected \SetaPDF_Core_Type_Dictionary_Entry[] PdfDictionary::$_entries = array()

The entries/values in the dictionary

An array of Dictionary\Entry objects

$_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.

$_pdfStringCallbacks

protected array PdfDictionary::$_pdfStringCallbacks = array()

An array of callbacks before this object is converted to a PDF string.

$_usePdfStringCallbacks

protected bool PdfDictionary::$_usePdfStringCallbacks = false

Defines if this object make use of pdf string callbacks

$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 PdfDictionary::ensureType (
mixed $dictionary
): self

Ensures that the passed value is a PdfDictionary instance.

Parameters
$dictionary : 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 PdfDictionary::writePdfString (
\SetaPDF_Core_WriteInterface $writer,
array $values
): void

Parses an associative array to a pdf dictionary string and writes it to a writer.

Parameters
$writer : \SetaPDF_Core_WriteInterface
 
$values : array
 
Exceptions

Throws \InvalidArgumentException

See

Methods

__construct()

public PdfDictionary::__construct (
?array $entries = null
)

The constructor.

Parameters
$entries : ?array

An array filled with Dictionary\Entry OR an associative array

Exceptions

Throws \InvalidArgumentException

__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.

_handlePdfStringCallback()

protected PdfDictionary::_handlePdfStringCallback (
void
): void

Execute the registered callbacks before the object is converted to a PDF string.

attach()

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

Add an observer to the object.

Implementation of the Observer Pattern. This overwritten method forwards the attach()-call to all dictionary values.

Parameters
$observer : \SplObserver
 

cleanUp()

public PdfDictionary::cleanUp (
void
): void

Release objects/memory.

See

count()

public PdfDictionary::count (
void
): int

Returns the number of elements in the dictionary.

current()

public PdfDictionary::current (
void
): \SetaPDF_Core_Type_AbstractType

Returns the current element.

deepClone()

public PdfDictionary::deepClone (): \SetaPDF_Core_Type_Dictionary

Clone the object recursively in the context of a document.

Parameters
$document : \SetaPDF_Core_Document
 

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 AbstractType::ensure (
?bool $forceObservation = null,
array &$ensuredObjectsList = array ( )
): \SetaPDF_Core_Type_AbstractType

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation : ?bool
 
$ensuredObjectsList : array

A list of all ensured indirect objects to prevent recursion

getKeys()

public PdfDictionary::getKeys (
void
): array

Returns the key names.

getValue()

public PdfDictionary::getValue (
?string $offset = null
): array|\SetaPDF_Core_Type_AbstractType|null

Gets the value.

Returns all entries of this dictionary or a specific value of a named entry.

Parameters
$offset : ?string

The name of the entry or null to receive all entries

Return Values

An array of Dictionary\Entry objects, a AbstractType instance or null if the given offset was not found

isObserved()

public AbstractType::isObserved (
void
): bool

Checks if this object is observed.

key()

public PdfDictionary::key (
void
): string

Returns the key of the current element.

next()

public PdfDictionary::next (
void
): \SetaPDF_Core_Type_AbstractType

Moves forward to next element.

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.

offsetExists()

public PdfDictionary::offsetExists (
string $offset
): bool

Checks whether a offset exists.

Parameters
$offset : string

An offset to check for.

offsetGet()

public PdfDictionary::offsetGet (
string $offset
): \SetaPDF_Core_Type_Dictionary_Entry

Offset to retrieve.

Parameters
$offset : string

The offset to retrieve.

offsetSet()

public PdfDictionary::offsetSet (): void

Offset to set.

If offset is null then the value need to be a Dictionary\Entry.

If value is scalar and offset is already set the setValue method of the offset will be used.

Otherwise, it should be an instance of AbstractType.

Parameters
$offset : null|string|\SetaPDF_Core_Type_Name

The offset to assign the value to.

$value : \SetaPDF_Core_Type_Dictionary_Entry|\SetaPDF_Core_Type_AbstractType|mixed

The value to set.

Exceptions

Throws \InvalidArgumentException

offsetUnset()

public PdfDictionary::offsetUnset (
string $offset
): void

Checks whether a offset exists.

Parameters
$offset : string
 

registerPdfStringCallback()

public PdfDictionary::registerPdfStringCallback (
callback $callback,
string $name
): void

Register a callback function which is called before the object is converted to a PDF string.

Parameters
$callback : callback
 
$name : string
 

rewind()

public PdfDictionary::rewind (
void
): void

Rewinds the Iterator to the first element.

setValue()

public PdfDictionary::setValue (
array $entries
): void

Set the values of the dictionary.

Parameters
$entries : array

Array of Dictionary\Entry objects

Exceptions

Throws \InvalidArgumentException

toPdfString()

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

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : ?\SetaPDF_Core_Document
 

toPhp()

public PdfDictionary::toPhp (
void
): array

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

unRegisterPdfStringCallback()

public PdfDictionary::unRegisterPdfStringCallback (
string $name
): void

Unregister a callback function.

Parameters
$name : string
 

update()

public PdfDictionary::update (
\SplSubject $subject
): void

Triggered if a value of this object is changed. Forward this to the "parent" object.

Parameters
$subject : \SplSubject
 

valid()

public PdfDictionary::valid (
void
): bool

Checks if current position is valid.

See

writeTo()

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

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

Parameters
$pdfDocument : \SetaPDF_Core_Document
 

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