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
$_observers
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.
Static Methods
_ensureType()
Ensure that a value is an instance of a specific PDF type.
Parameters
- $type
- $value
- $errorMessage
- $ensure
Exceptions
Throws SetaPDF_Core_Type_Exception
ensureType()
Ensures that the passed value is a SetaPDF_Core_Type_HexString instance.
Parameters
- $hexString
Exceptions
Throws SetaPDF_Core_Type_Exception
ensureWithType()
Ensures that the passed value is an instance of the passed type.
Parameters
- $type
- $value
Exceptions
Throws SetaPDF_Core_Type_Exception
writePdfString()
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()
The constructor.
Parameters
- $value
- $fromString
- $owningObject
__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.
attach()
Add an observer to the object.
Implementation of the Observer Pattern.
Parameters
- $observer : SplObserver
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
ensure()
Returns the main value.
This method is used for automatically resolving of indirect references.
Parameters
- $forceObservation
getValue()
Get the value.
If $asString is set to true the value will be passed to the hex2str() method before it is returned.
Parameters
- $asString
notify()
Notifies all attached observers.
Implementation of the Observer Pattern.
Has to be called by any method that changes a value.
toPdfString()
Returns the type as a formatted PDF string.
Parameters
- $pdfDocument : SetaPDF_Core_Document|null
writeTo()
Writes the type as a formatted PDF string to the document.
Parameters
- $pdfDocument : SetaPDF_Core_Document