Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Type
        1. Dictionary
        2. Dictionary
        3. IndirectReference
        4. IndirectReference
        5. AbstractType
        6. Array
        7. Boolean
        8. BypassSecHandlerInterface
        9. Callback
        10. Exception
        11. HexString
        12. IndirectObject
        13. IndirectObjectInterface
        14. Name
        15. Null
        16. Numeric
        17. ObjectStream
        18. Owner
        19. Raw
        20. ScalarValue
        21. Stream
        22. String
        23. StringValue
        24. Token

SetaPDF_Core_Type_Array Class representing an array

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

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Properties

$_count

protected int SetaPDF_Core_Type_Array::$_count = 0

The array count

$_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.

$_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 (
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_Array::ensureType (
mixed $array [, null|int $size = null ]
): SetaPDF_Core_Type_Array

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

Parameters
$array : mixed
 
$size : null|int
 
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_Array::writePdfString (
SetaPDF_Core_WriteInterface $writer, array $values
): void

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

Parameters
$writer : SetaPDF_Core_WriteInterface
 
$values : array
 
Exceptions

Throws InvalidArgumentException

See

Methods

__construct()

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

The constructor.

Parameters
$values : array

An array filled with values of type SetaPDF_Core_Type_AbstractType

Exceptions

Throws InvalidArgumentException

__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_Array::attach (
SplObserver $observer
): void

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
): int

Returns the number of elements in the array.

current()

public SetaPDF_Core_Type_Array::current (
void
): SetaPDF_Core_Type_AbstractType

Returns the current element.

deepClone()

public SetaPDF_Core_Type_Array::deepClone (): 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
 

getChildren()

public SetaPDF_Core_Type_Array::getChildren (
void
): array

Returns an iterator for the current entry.

getValue()

public SetaPDF_Core_Type_Array::getValue (
void
): array

Get the value.

hasChildren()

public SetaPDF_Core_Type_Array::hasChildren (
void
): bool

Check whether the current entry is an SetaPDF_Core_Type_Array.

indexOf()

public SetaPDF_Core_Type_Array::indexOf (): int

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 [, null|int $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 : null|int
 
Exceptions

Throws InvalidArgumentException

isObserved()

public SetaPDF_Core_Type_AbstractType::isObserved (
void
): bool

Checks if this object is observed.

key()

public SetaPDF_Core_Type_Array::key (
void
): int

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
): SetaPDF_Core_Type_AbstractType

Moves forward to next element.

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.

offsetExists()

public SetaPDF_Core_Type_Array::offsetExists (
int $offset
): bool

Checks whether a offset exists.

Parameters
$offset : int

An offset to check for.

offsetGet()

public SetaPDF_Core_Type_Array::offsetGet (
int $offset
): SetaPDF_Core_Type_AbstractType|null

Offset to retrieve.

Parameters
$offset : int

The offset to retrieve.

offsetSet()

public SetaPDF_Core_Type_Array::offsetSet (
null|int $offset, SetaPDF_Core_Type_AbstractType $value
): void

Offset to set.

Parameters
$offset : null|int

The offset to assign the value to.

$value : SetaPDF_Core_Type_AbstractType

The value to set.

Exceptions

Throws InvalidArgumentException

offsetUnset()

public SetaPDF_Core_Type_Array::offsetUnset (
string $offset
): void

Checks whether an offset exists.

Parameters
$offset : string
 

push()

public SetaPDF_Core_Type_Array::push (): void

Pushes a value onto the end of the array.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 

rewind()

public SetaPDF_Core_Type_Array::rewind (
void
): void

Rewinds the Iterator to the first element.

setValue()

public SetaPDF_Core_Type_Array::setValue (
array|SetaPDF_Core_Type_Array $values
): void

Sets the values.

Parameters
$values : array|SetaPDF_Core_Type_Array

An array of SetaPDF_Core_Type_AbstractType objects

Exceptions

Throws InvalidArgumentException

toPdfString()

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

Returns the type as a formatted PDF string.

Parameters
$pdfDocument : SetaPDF_Core_Document|null
 

toPhp()

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

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

Parameters
$ensure : bool
 
See

unshift()

public SetaPDF_Core_Type_Array::unshift (): void

Prepends one element to the beginning of the array.

Parameters
$value : SetaPDF_Core_Type_AbstractType
 

update()

public SetaPDF_Core_Type_Array::update (
SplSubject $SplSubject
): void

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
): bool

Checks if current position is valid.

See

writeTo()

public SetaPDF_Core_Type_Array::writeTo (
SetaPDF_Core_Document $pdfDocument
): void

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

Parameters
$pdfDocument : SetaPDF_Core_Document
 

© 2022 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)