SetaPDF_Core_Type_Token Class representing a token

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

Class hierarchy

Implements

Summary

Properties

$_observed

protected boolean SetaPDF_Core_Type_Token::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_Token::$_observers = array()

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

$_value

protected boolean|string SetaPDF_Core_Type_Token::$_value = false

The token value


Static Methods

writePdfString()

static public string|void SetaPDF_Core_Type_Token::writePdfString ( SetaPDF_Core_WriteInterface $writer, null|string $value )

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

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value : null|string
 
Exceptions

Throws InvalidArgumentException


Methods

__construct()

public SetaPDF_Core_Type_Token::__construct ( [ string $value = null ] )

The constructor.

Parameters
$value : string
 

__clone()

public void SetaPDF_Core_Type_AbstractType::__clone ( void )

Implementation of __clone().

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

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

This method is used to clean up an object by releasing memory and references.

The observers has to be removed with the detach()-method. Only if there is no observer left this method should really release resources.

The method has to be implemented by each object type

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 string SetaPDF_Core_Type_Token::getValue ( void )

Get the token value.

See

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_Token::setValue ( string $value )

Set the token value.

Parameters
$value : string
 
See

toPdfString()

public string SetaPDF_Core_Type_Token::toPdfString ( SetaPDF_Core_Document $pdfDocument )

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public string SetaPDF_Core_Type_Token::toPhp ( void )

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

writeTo()

public void SetaPDF_Core_Type_Token::writeTo ( SetaPDF_Core_Document $pdfDocument )

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

Parameters
$pdfDocument : SetaPDF_Core_Document