SetaPDF_Core_Type_Name Class representing a name object

File: /SetaPDF v2/Core/Type/Name.php

Class hierarchy

Implements

Summary

Properties

$_observed

protected boolean SetaPDF_Core_Type_Name::$_observed = false

Defines if this object is under observation

$_observers

protected array SetaPDF_Core_Type_Name::$_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.

$_rawValue

protected string SetaPDF_Core_Type_Name::$_rawValue = ''

The escaped value

$_value

protected string SetaPDF_Core_Type_Name::$_value = ''

The plaintext value


Static Methods

_escapeChar()

protected static SetaPDF_Core_Type_Name::_escapeChar (
array $matches
): string

Converting a character into a 2-digit hexadecimal code prefixed by a number sign.

Parameters
$matches : array
 

_unescapeChar()

protected static SetaPDF_Core_Type_Name::_unescapeChar (
array $matches
): string

Converts a 2-digit hexadecimal code representation into a single byte/character.

Parameters
$matches : array
 

escape()

public static SetaPDF_Core_Type_Name::escape (
string $value
): string

Escapes a name string.

Parameters
$value : string
 

unescape()

public static SetaPDF_Core_Type_Name::unescape (
string $value
): string

Unescapes a name string.

Parameters
$value : string
 

writePdfString()

public static SetaPDF_Core_Type_Name::writePdfString (
SetaPDF_Core_WriteInterface $writer, string $value [, boolean $isRawValue = false ]
): void

Parses a php string value to a pdf name string and write it into a writer.

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value : string
 
$isRawValue : boolean
 
Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

public SetaPDF_Core_Type_Name::__construct (
[ string $value = null [, boolean $raw = false ]]
)

The constructor.

Parameters
$value : string
 
$raw : boolean
 

__clone()

Implementation of __clone().

__sleep()

public SetaPDF_Core_Type_AbstractType::__sleep (
void
): array

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
 

cleanUp()

This method is used to clean up an object by releasing memory and references.

The observers has to be removed with the detach()-method. Only if there is no observer left this method should really release resources.

The method has to be implemented by each object type

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 (
[ boolean|null $forceObservation = null ]
): SetaPDF_Core_Type_AbstractType

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation : boolean|null
 

getValue()

public SetaPDF_Core_Type_Name::getValue (
void
): string

Get the name value.

See

isObserved()

public SetaPDF_Core_Type_AbstractType::isObserved (
void
): boolean

Checks if this object is observed.

notify()

public SetaPDF_Core_Type_AbstractType::notify (
void
): void

Notifies all attached observers.

Implementation of the Observer Pattern.

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

setValue()

public SetaPDF_Core_Type_Name::setValue (
mixed $value
): void

Set the name value.

Parameters
$value : mixed
 
See

toPdfString()

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public SetaPDF_Core_Type_Name::toPhp (
void
): string

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