SetaPDF_Core_Type_Array Class representing an array

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

Class hierarchy

Implements

Summary

Properties

$_count

protected int SetaPDF_Core_Type_Array::$_count = 0

The array count

$_observed

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.

$_values

protected array SetaPDF_Core_Type_Array::$_values = array()

The values

An array of SetaPDF_Core_Type_AbstractType objects


Static Methods

_ensureType()

protected static SetaPDF_Core_Type_AbstractType::_ensureType (
$type, $value, $errorMessage [, $ensure = true ]
):

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

Parameters
$type
 
$value
 
$errorMessage
 
$ensure
 
Exceptions

Throws SetaPDF_Core_Type_Exception

ensureType()

public static SetaPDF_Core_Type_Array::ensureType (
$array [, $size = null ]
):

Ensures that the passed array is a SetaPDF_Core_Type_Array instance with a (optional) specific size.

Parameters
$array
 
$size
 
Exceptions

Throws SetaPDF_Core_Type_Exception

ensureWithType()

public static SetaPDF_Core_Type_AbstractType::ensureWithType (
$type, $value
):

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

Parameters
$type
 
$value
 
Exceptions

Throws SetaPDF_Core_Type_Exception

writePdfString()

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

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$values
 
Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

public SetaPDF_Core_Type_Array::__construct (
[ array|null $values = null ]
)

The constructor.

Parameters
$values : array|null

An array filled with values of type SetaPDF_Core_Type_AbstractType

Exceptions

Throws InvalidArgumentException

__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.

__wakeup()

Implementation of __wakeup.

Unset the observed flag.

attach()

Add an observer to the object.

This method forwards the "attach()"-call to all values of this array.

Parameters
$observer : SplObserver
 

cleanUp()

public SetaPDF_Core_Type_Array::cleanUp (
void
): void

Release objects/memory.

See

clear()

public SetaPDF_Core_Type_Array::clear (
void
): void

Clears the array.

count()

public SetaPDF_Core_Type_Array::count (
void
):

Returns the number of elements in the array.

current()

public SetaPDF_Core_Type_Array::current (
void
):

Returns the current element.

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

Returns the main value.

This method is used for automatically resolving of indirect references.

Parameters
$forceObservation
 

getChildren()

Returns an iterator for the current entry.

getValue()

Get the value.

hasChildren()

Check whether the current entry is an SetaPDF_Core_Type_Array.

indexOf()

Returns the index of the element.

If the element isn't in this array -1 will returned.

Parameters
$element : SetaPDF_Core_Type_AbstractType
 

insertBefore()

public SetaPDF_Core_Type_Array::insertBefore (
SetaPDF_Core_Type_AbstractType $value [, $beforeIndex = 0 ]
): void

Inserts an element before another one.

Index mustn't be higher than the count of elements in array.

Index 0 is allowed in an empty array.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 
$beforeIndex
 
Exceptions

Throws InvalidArgumentException

isObserved()

Checks if this object is observed.

key()

public SetaPDF_Core_Type_Array::key (
void
):

Returns the key of the current element.

merge()

public SetaPDF_Core_Type_Array::merge (
void
): void

Merges this PDF array with other PDF arrays.

Exceptions

Throws InvalidArgumentException

mergeUnique()

public SetaPDF_Core_Type_Array::mergeUnique (
void
): void

Merges this PDF array with other PDF arrays while only taking not existing values.

Exceptions

Throws InvalidArgumentException

next()

public SetaPDF_Core_Type_Array::next (
void
):

Moves forward to next element.

notify()

Notifies all attached observers.

Implementation of the Observer Pattern.

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

offsetExists()

Checks whether a offset exists.

Parameters
$offset

An offset to check for.

offsetGet()

public SetaPDF_Core_Type_Array::offsetGet (
$offset
):

Offset to retrieve.

Parameters
$offset

The offset to retrieve.

offsetSet()

public SetaPDF_Core_Type_Array::offsetSet (
$offset, $value
):

Offset to set.

Parameters
$offset

The offset to assign the value to.

$value

The value to set.

Exceptions

Throws InvalidArgumentException

offsetUnset()

public SetaPDF_Core_Type_Array::offsetUnset (
$offset
):

Checks whether an offset exists.

Parameters
$offset
 

push()

Pushes a value onto the end of the array.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 

rewind()

public SetaPDF_Core_Type_Array::rewind (
void
):

Rewinds the Iterator to the first element.

Return Values

Any returned value is ignored.

setValue()

public SetaPDF_Core_Type_Array::setValue (
$values
): void

Sets the values.

Parameters
$values

An array of SetaPDF_Core_Type_AbstractType objects

Exceptions

Throws InvalidArgumentException

toPdfString()

public SetaPDF_Core_Type_Array::toPdfString (
[ SetaPDF_Core_Document|null $pdfDocument = null ]
):

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document|null
 

toPhp()

public SetaPDF_Core_Type_Array::toPhp (
[ $ensure = false ]
):

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

Parameters
$ensure
 
See

unshift()

Prepends one element to the beginning of the array.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 

update()

public SetaPDF_Core_Type_Array::update (
SplSubject $SplSubject
):

Triggered if a value of this object is changed.

Forward this to other observers.

Parameters
$SplSubject : SplSubject
 

valid()

public SetaPDF_Core_Type_Array::valid (
void
):

Checks if current position is valid.

See

writeTo()

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

Parameters
$pdfDocument : SetaPDF_Core_Document