SetaPDF_Core_Type_String Class representing a string

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

Class hierarchy

Implements

Summary

Properties

$_bypassSecHandler

protected boolean SetaPDF_Core_Type_String::$_bypassSecHandler = false

Flag saying that this stream should by pass the security handler

$_encrypted

protected boolean SetaPDF_Core_Type_String::$_encrypted = false

Flag saying that the stream is encrypted or not

$_observed

protected boolean SetaPDF_Core_Type_String::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_String::$_observers = array()

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

$_owningObject

Needed if the string is encrypted

$_rawValue

protected string SetaPDF_Core_Type_String::$_rawValue = ''

The escaped/encrypted value

$_value

protected string SetaPDF_Core_Type_String::$_value = ''

The plaintext value


Static Methods

escape()

static public string SetaPDF_Core_Type_String::escape ( string $s )

Escapes sequences in a string according to the PDF specification.

Parameters
$s : string
 

unescape()

static public string SetaPDF_Core_Type_String::unescape ( string $s )

Unescapes escaped sequences in a PDF string according to the PDF specification.

Parameters
$s : string
 

writePdfString()

static public void SetaPDF_Core_Type_String::writePdfString ( SetaPDF_Core_WriteInterface $writer, string|mixed $value )

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

public SetaPDF_Core_Type_String::__construct ( [ string $value = '' [, boolean $raw = false [, SetaPDF_Core_Type_IndirectObject $owningObject = null ]]] )

The constructor.

Parameters
$value : string
 
$raw : boolean
 
$owningObject : SetaPDF_Core_Type_IndirectObject
 

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

protected string SetaPDF_Core_Type_String::_decrypt ( void )

Decrypts the string (if needed).

attach()

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters
$observer : SplObserver
 

cleanUp()

public void SetaPDF_Core_Type_String::cleanUp ( void )

Release objects/memory.

See

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

Get the string value.

See

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 void SetaPDF_Core_Type_String::setBypassSecHandler ( [ boolean $bypassSecHandler = true ] )

Set the bypass security handler flag.

Parameters
$bypassSecHandler : boolean
 

setValue()

public void SetaPDF_Core_Type_String::setValue ( string $value )

Set the string value.

Parameters
$value : string
 
See

toPdfString()

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public string SetaPDF_Core_Type_String::toPhp ( void )

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

writeTo()

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

Parameters
$pdfDocument : SetaPDF_Core_Document