SetaPDF_Core_Type_HexString Class representing a hexadecimal string

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

Class hierarchy

Implements

Summary

Static Properties

$_filter

A singleton AsciiHex filter instance


Properties

$_bypassSecHandler

Flag indicating that the object should bypass the security handler

$_encrypted

protected boolean SetaPDF_Core_Type_HexString::$_encrypted = false

Flag indicating if the string is currently encrypted

$_observed

protected boolean SetaPDF_Core_Type_HexString::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_HexString::$_observers = array()

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

$_owningObject

$_value

protected string SetaPDF_Core_Type_HexString::$_value = ''

The value


Static Methods

_getFilter()

static private SetaPDF_Core_Filter_AsciiHex SetaPDF_Core_Type_HexString::_getFilter ( void )

Singleton method to get an AsciiHex filter instance.

hex2str()

static public string SetaPDF_Core_Type_HexString::hex2str ( string $hex )

Converts a hex encoded string to a normal string.

Parameters
$hex : string
 

str2hex()

static public string SetaPDF_Core_Type_HexString::str2hex ( string $str )

Converts a string to a hex encoded string.

Parameters
$str : string
 

writePdfString()

static public string|void SetaPDF_Core_Type_HexString::writePdfString ( SetaPDF_Core_WriteInterface $writer, string $value [, boolean $fromString = true ] )

Writes a string as hex encoded string to a writer instance.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value : string
 
$fromString : boolean

Convert the string to hex encoded string

Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

public SetaPDF_Core_Type_HexString::__construct ( [ string $value = null [, boolean $fromString = true [, SetaPDF_Core_Type_AbstractType $owningObject = null ]]] )

The constructor.

Parameters
$value : string
 
$fromString : boolean
 
$owningObject : SetaPDF_Core_Type_AbstractType
 

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

_decrypt()

protected string SetaPDF_Core_Type_HexString::_decrypt ( void )

Decrypts the value.

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

Release memory.

See

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_HexString::getValue ( [ boolean $asString = true ] )

Get the value.

If $asString is set to true the value will be passed to the hex2str() method before it is returned.

Parameters
$asString : boolean
 

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.

setBypassSecHandler()

public void SetaPDF_Core_Type_HexString::setBypassSecHandler ( [ boolean $bypassSecHandler = true ] )

Bypass the security handler or not.

Parameters
$bypassSecHandler : boolean
 

setValue()

public void SetaPDF_Core_Type_HexString::setValue ( string $value [, boolean $fromString = true ] )

Set the value.

Parameters
$value : string
 
$fromString : boolean
 

toPdfString()

public string SetaPDF_Core_Type_HexString::toPdfString ( SetaPDF_Core_Document $pdfDocument )

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public string SetaPDF_Core_Type_HexString::toPhp ( void )

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

See

writeTo()

public void SetaPDF_Core_Type_HexString::writeTo ( SetaPDF_Core_Document $pdfDocument )

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

Parameters
$pdfDocument : SetaPDF_Core_Document