SetaPDF_Core_Type_String Class representing a string
File: /SetaPDF v2/Core/Type/String.php
Class hierarchy
Implements
Summary
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
unescape()
Unescapes escaped sequences in a PDF string according to the PDF specification.
Parameters
- $s : string
writePdfString()
Parses a php string value to a pdf string and write it into a writer.
Parameters
- $writer : SetaPDF_Core_WriteInterface
- $value : string|mixed
If it's not a string, it need to have a __toString() implementation.
Exceptions
Throws InvalidArgumentException
See
Methods
__construct()
The constructor.
Parameters
- $value : string
- $raw : boolean
- $owningObject : SetaPDF_Core_Type_IndirectObject
__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 : boolean|null
notify()
Notifies all attached observers.
Implementation of the Observer Pattern.
Has to be called by any method that changes a value.
toPdfString()
writeTo()
Writes the type as a formatted PDF string to the document.
Parameters
- $pdfDocument : SetaPDF_Core_Document