SetaPDF_Core_Type_Boolean Class representing a boolean value

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

Class hierarchy

Implements

Summary

Properties

$_observed

protected boolean SetaPDF_Core_Type_Boolean::$_observed = false

Defines if this object is under observation

$_observers

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

$_value

protected $_value SetaPDF_Core_Type_Boolean::$_value = false

boolean

The value


Static Methods

writePdfString()

public static SetaPDF_Core_Type_Boolean::writePdfString (
SetaPDF_Core_WriteInterface $writer, boolean $value
): void

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

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$value : boolean
 
Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

public SetaPDF_Core_Type_Boolean::__construct (
[ boolean $value = null ]
)

The constructor.

Parameters
$value : 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_Boolean::getValue (
void
): boolean

Gets the value.

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_Boolean::setValue (
boolean $value
): void

Set the value.

Parameters
$value : boolean
 

toPdfString()

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document
 

toPhp()

public SetaPDF_Core_Type_Boolean::toPhp (
void
): boolean

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