SetaPDF_Core_Type_HexString Class representing a hexadecimal string

File: /SetaPDF v2/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

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.

$_owningObject

$_value

protected string SetaPDF_Core_Type_HexString::$_value = ''

The value


Static Methods

_ensureType()

protected static SetaPDF_Core_Type_AbstractType::_ensureType (
$type, $value, $errorMessage [, $ensure = true ]
):

Ensure that a value is an instance of a specific PDF type.

Parameters
$type
 
$value
 
$errorMessage
 
$ensure
 
Exceptions

Throws SetaPDF_Core_Type_Exception

_getFilter()

private static SetaPDF_Core_Type_HexString::_getFilter (
void
):

Singleton method to get an AsciiHex filter instance.

ensureType()

public static SetaPDF_Core_Type_HexString::ensureType (
$hexString
):

Ensures that the passed value is a SetaPDF_Core_Type_HexString instance.

Parameters
$hexString
 
Exceptions

Throws SetaPDF_Core_Type_Exception

ensureWithType()

public static SetaPDF_Core_Type_AbstractType::ensureWithType (
$type, $value
):

Ensures that the passed value is an instance of the passed type.

Parameters
$type
 
$value
 
Exceptions

Throws SetaPDF_Core_Type_Exception

hex2str()

public static SetaPDF_Core_Type_HexString::hex2str (
$hex
):

Converts a hex encoded string to a normal string.

Parameters
$hex
 

str2hex()

public static SetaPDF_Core_Type_HexString::str2hex (
$str
):

Converts a string to a hex encoded string.

Parameters
$str
 

writePdfString()

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

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

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value
 
$fromString

Convert the string to hex encoded string

Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

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

The constructor.

Parameters
$value
 
$fromString
 
$owningObject
 

__clone()

Implementation of __clone().

__sleep()

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()

Decrypts the value.

attach()

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

cleanUp()

deepClone()

Clone the object recursively in the context of a document.

Parameters
$document : SetaPDF_Core_Document
 

detach()

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

detachAll()

Detach all observers from this object.

Be careful with this method!!!

ensure()

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

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation
 

getValue()

public SetaPDF_Core_Type_HexString::getValue (
[ $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
 

isObserved()

Checks if this object is observed.

notify()

Notifies all attached observers.

Implementation of the Observer Pattern.

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

setBypassSecHandler()

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

Bypass the security handler or not.

Parameters
$bypassSecHandler
 

setValue()

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

Set the value.

Parameters
$value
 
$fromString
 

toPdfString()

public SetaPDF_Core_Type_HexString::toPdfString (
[ SetaPDF_Core_Document|null $pdfDocument = null ]
):

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document|null
 

toPhp()

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

See

writeTo()

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

Parameters
$pdfDocument : SetaPDF_Core_Document