Abstract Class SetaPDF_Core_Type_AbstractType in SetaPDF v2 API Reference

SetaPDF_Core_Type_AbstractType Abstract class for all PDF types

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

Class hierarchy

SetaPDF_Core_Type_AbstractType

Implements

SplSubject

Summary

Properties

$_observed

protected bool SetaPDF_Core_Type_AbstractType::$_observed = false

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.

$metadata

public array SetaPDF_Core_Type_AbstractType::$metadata = array()

An array for individual metadata.

Static Methods

_ensureType()

protected static SetaPDF_Core_Type_AbstractType::_ensureType (

string $type, mixed $value, string $errorMessage [, $ensure = true ]

): mixed

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

Parameters

$type : string
$value : mixed
$errorMessage : string
$ensure

Exceptions

Throws SetaPDF_Core_Type_Exception

ensureType()

public static SetaPDF_Core_Type_AbstractType::ensureType (

mixed $value

): SetaPDF_Core_Type_AbstractType

Ensures that the passed value is a SetaPDF_Core_Type_AbstractType instance.

Parameters

$value : mixed

Exceptions

Throws SetaPDF_Core_Type_Exception

ensureWithType()

public static SetaPDF_Core_Type_AbstractType::ensureWithType (

string $type, mixed $value

): SetaPDF_Core_Type_AbstractType

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

Parameters

$type : string
$value : mixed

Exceptions

Throws SetaPDF_Core_Type_Exception

is()

public static SetaPDF_Core_Type_AbstractType::is (

string $type, mixed $value [, bool $ensure = true ]

): bool

Checks if the type of a value is the expected one.

Indirect references will be evaluated if $ensure is set to true.

Parameters

$type : string
$value : mixed
$ensure : bool

writePdfString()

public static SetaPDF_Core_Type_AbstractType::writePdfString (

SetaPDF_Core_WriteInterface $writer, mixed $value

): void

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

PHP data type -> PDF data type

Null -> SetaPDF_Core_Type_Null

Boolean -> SetaPDF_Core_Type_Boolean

Integer/Double -> SetaPDF_Core_Type_Numeric

String -> SetaPDF_Core_Type_String or SetaPDF_Core_Type_Name(if the string starts with "/")

Indexed array -> SetaPDF_Core_Type_Array

Associative array -> SetaPDF_Core_Type_Dictionary

Parameters

$writer : SetaPDF_Core_WriteInterface
$value : mixed

Exceptions

Throws InvalidArgumentException

Methods

__construct()

public SetaPDF_Core_Type_AbstractType::__construct (

void

)

The constructor.

__clone()

public SetaPDF_Core_Type_AbstractType::__clone (

void

): void

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.

__wakeup()

public SetaPDF_Core_Type_AbstractType::__wakeup (

void

): void

Implementation of __wakeup.

Unset the observed flag.

attach()

public SetaPDF_Core_Type_AbstractType::attach (

SplObserver $observer

): void

Add an observer to the object.

Implementation of the Observer Pattern.

Parameters

$observer : SplObserver

cleanUp()

public SetaPDF_Core_Type_AbstractType::cleanUp (

void

): void

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

The observers have 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()

public SetaPDF_Core_Type_AbstractType::deepClone (

SetaPDF_Core_Document $document

): SetaPDF_Core_Type_AbstractType

Clone the object recursively in the context of a document.

Parameters

$document : SetaPDF_Core_Document

detach()

public SetaPDF_Core_Type_AbstractType::detach (

SplObserver $observer

): void

Detach an observer from the object.

Implementation of the Observer Pattern.

Parameters

$observer : SplObserver

detachAll()

public SetaPDF_Core_Type_AbstractType::detachAll (

void

): void

Detach all observers from this object.

Be careful with this method!!!

ensure()

public SetaPDF_Core_Type_AbstractType::ensure (

[ bool|null $forceObservation = null ]

): SetaPDF_Core_Type_AbstractType

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters

$forceObservation : bool|null

getValue()

abstract public SetaPDF_Core_Type_AbstractType::getValue (

void

): mixed

Gets the PDF value.

isObserved()

public SetaPDF_Core_Type_AbstractType::isObserved (

void

): bool

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

abstract public SetaPDF_Core_Type_AbstractType::setValue (

mixed $value

): void

Sets the value of the PDF type.

Parameters

$value : mixed

toPdfString()

abstract public SetaPDF_Core_Type_AbstractType::toPdfString (

[ SetaPDF_Core_Document $pdfDocument = null ]

): string

Returns the type as a formatted PDF string.

Parameters

$pdfDocument : SetaPDF_Core_Document

toPhp()

abstract public SetaPDF_Core_Type_AbstractType::toPhp (

void

): mixed

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

writeTo()

abstract public SetaPDF_Core_Type_AbstractType::writeTo (

SetaPDF_Core_Document $pdfDocument

): void

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

Parameters

$pdfDocument : SetaPDF_Core_Document