SetaPDF_Core_Type_Callback This class acts like a proxy for all available SetaPDF_Core_Type_* classes

File: /SetaPDF/Core/Type/Callback.php

The class allows a developer to attach callbacks before and/or after any native method of the original type instance.

Class hierarchy

Implements

Summary

Properties

$_callbacks

$_observed

protected boolean SetaPDF_Core_Type_Callback::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_Callback::$_observers = array()

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


Static Methods

writePdfString()

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

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_Callback::__construct ( SetaPDF_Core_Type_AbstractType $value )

Constructor.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 

__call()

public mixed SetaPDF_Core_Type_Callback::__call ( string $method, array $arguments )

Overloads all method calls.

Parameters
$method : string
 
$arguments : array
 
Exceptions

Throws BadMethodCallException

__sleep()

public array SetaPDF_Core_Type_AbstractType::__sleep ( void )

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 void SetaPDF_Core_Type_AbstractType::__wakeup ( void )

Implementation of __wakeup.

Unset the observed flag.

addCallback()

public void SetaPDF_Core_Type_Callback::addCallback ( string $method, callback $callback [, bool $before = true ] )

Add a callback before or after a specific method call.

Parameters
$method : string
 
$callback : callback
 
$before : bool
 
Exceptions

Throws InvalidArgumentException

attach()

public void SetaPDF_Core_Type_AbstractType::attach ( SplObserver $observer )

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

cleanUp()

public void SetaPDF_Core_Type_Callback::cleanUp ( void )

Release resources/memory.

deepClone()

public SetaPDF_Core_Type_AbstractType SetaPDF_Core_Type_AbstractType::deepClone ( SetaPDF_Core_Document $document )

Clone the object recursively in the context of a document.

Parameters
$document : SetaPDF_Core_Document
 

detach()

public void SetaPDF_Core_Type_AbstractType::detach ( SplObserver $observer )

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

detachAll()

public void SetaPDF_Core_Type_AbstractType::detachAll ( void )

Detach all observers from this object.

Be careful with this method!!!

ensure()

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

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation : boolean|null
 

getValue()

public mixed SetaPDF_Core_Type_Callback::getValue ( void )

Gets the PDF value.

isObserved()

public boolean SetaPDF_Core_Type_AbstractType::isObserved ( void )

Checks if this object is observed.

notify()

public void SetaPDF_Core_Type_AbstractType::notify ( void )

Notifies all attached observers.

Implementation of the Observer Pattern.

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

setValue()

public void SetaPDF_Core_Type_Callback::setValue ( mixed $value )

Sets the value of the PDF type.

Parameters
$value : mixed
 

toPdfString()

public string SetaPDF_Core_Type_Callback::toPdfString ( SetaPDF_Core_Document $pdfDocument )

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public mixed SetaPDF_Core_Type_Callback::toPhp ( void )

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

writeTo()

public void SetaPDF_Core_Type_Callback::writeTo ( SetaPDF_Core_Document $pdfDocument )

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

Parameters
$pdfDocument : SetaPDF_Core_Document