Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Type
        1. Dictionary
        2. Dictionary
          1. Entry
          2. Helper

SetaPDF_Core_Type_Dictionary Class representing a dictionary

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

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_entries

protected SetaPDF_Core_Type_Dictionary_Entry[] SetaPDF_Core_Type_Dictionary::$_entries = array()

The entries/values in the dictionary

An array of SetaPDF_Core_Type_Dictionary_Entry objects

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

$_pdfStringCallbacks

protected array SetaPDF_Core_Type_Dictionary::$_pdfStringCallbacks = array()

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

$_usePdfStringCallbacks

protected bool SetaPDF_Core_Type_Dictionary::$_usePdfStringCallbacks = false

Defines if this object make use of pdf string callbacks

$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_Dictionary::ensureType (
mixed $dictionary
): SetaPDF_Core_Type_Dictionary

Ensures that the passed value is a PdfDictionary instance.

Parameters
$dictionary : 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_Dictionary::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 SetaPDF_Core_Type_Dictionary::__construct (
[ array $entries = null ]
)

The constructor.

Parameters
$entries : array

An array filled with SetaPDF_Core_Type_Dictionary_Entry OR an associative array

Exceptions

Throws InvalidArgumentException

__sleep()

public SetaPDF_Core_Type_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 SetaPDF_Core_Type_Dictionary::_handlePdfStringCallback (
void
): void

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

attach()

public SetaPDF_Core_Type_Dictionary::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 SetaPDF_Core_Type_Dictionary::cleanUp (
void
): void

Release objects/memory.

See

count()

public SetaPDF_Core_Type_Dictionary::count (
void
): int

Returns the number of elements in the dictionary.

current()

public SetaPDF_Core_Type_Dictionary::current (
void
): SetaPDF_Core_Type_AbstractType

Returns the current element.

deepClone()

public SetaPDF_Core_Type_Dictionary::deepClone (): SetaPDF_Core_Type_Dictionary

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_AbstractType::ensure (
[ bool|null $forceObservation = null ]
): SetaPDF_Core_Type_AbstractType

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation : bool|null
 

getKeys()

public SetaPDF_Core_Type_Dictionary::getKeys (
void
): array

Returns the key names.

getValue()

public SetaPDF_Core_Type_Dictionary::getValue (
[ string|null $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|null

The name of the entry or null to receive all entries

Return Values

An array of SetaPDF_Core_Type_Dictionary_Entry objects, a SetaPDF_Core_Type_AbstractType instance or null if the given offset was not found

isObserved()

public SetaPDF_Core_Type_AbstractType::isObserved (
void
): bool

Checks if this object is observed.

key()

public SetaPDF_Core_Type_Dictionary::key (
void
): string

Returns the key of the current element.

next()

public SetaPDF_Core_Type_Dictionary::next (
void
): SetaPDF_Core_Type_AbstractType

Moves forward to next element.

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.

offsetExists()

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

Checks whether a offset exists.

Parameters
$offset : string

An offset to check for.

offsetGet()

public SetaPDF_Core_Type_Dictionary::offsetGet (
string $offset
): SetaPDF_Core_Type_Dictionary_Entry

Offset to retrieve.

Parameters
$offset : string

The offset to retrieve.

offsetSet()

public SetaPDF_Core_Type_Dictionary::offsetSet (): void

Offset to set.

If offset is null then the value need to be a SetaPDF_Core_Type_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 SetaPDF_Core_Type_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 SetaPDF_Core_Type_Dictionary::offsetUnset (
string $offset
): void

Checks whether a offset exists.

Parameters
$offset : string
 

registerPdfStringCallback()

public SetaPDF_Core_Type_Dictionary::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 SetaPDF_Core_Type_Dictionary::rewind (
void
): void

Rewinds the Iterator to the first element.

setValue()

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

Set the values of the dictionary.

Parameters
$entries : array

Array of SetaPDF_Core_Type_Dictionary_Entry objects

Exceptions

Throws InvalidArgumentException

toPdfString()

public SetaPDF_Core_Type_Dictionary::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_Dictionary::toPhp (
void
): array

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

unRegisterPdfStringCallback()

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

Unregister a callback function.

Parameters
$name : string
 

update()

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

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

Parameters
$SplSubject : SplSubject
 

valid()

public SetaPDF_Core_Type_Dictionary::valid (
void
): bool

Checks if current position is valid.

See

writeTo()

public SetaPDF_Core_Type_Dictionary::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)