Index

  1. \setasign\SetaPDF2
    1. Core
      1. DataStructure
        1. Tree
          1. AbstractTree
          2. KeyAlreadyExistsException
          3. NameTree
          4. NumberTree

setasign\SetaPDF2\Core\DataStructure\Tree

NumberTree Data structure class for Number Trees

File: /SetaPDF v2/Core/DataStructure/Tree/NumberTree.php
Old class name (alias): \SetaPDF_Core_DataStructure_NumberTree

Class hierarchy

Implements

Summary

Static Properties

Methods

Properties

Static Properties

$leafNodesPerNode

static public int AbstractTree::$leafNodesPerNode = 64

Leaf nodes per node


Properties

$_document

protected \setasign\SetaPDF2\Core\Document AbstractTree::$_document

The document to which the tree depends on

$_isNew

protected bool AbstractTree::$_isNew = false

Is this a new tree or should we update an existing one

$_rootDictionary

protected \setasign\SetaPDF2\Core\Type\PdfDictionary AbstractTree::$_rootDictionary

The dictionary entry in the dictionary of the root object

$_values

protected array AbstractTree::$_values = array()

A cache for resolved entries

The index is the key while the value is an array of both key and value object.


Methods

__construct()

public AbstractTree::__construct ()

The constructor.

Parameters
$rootDictionary : \setasign\SetaPDF2\Core\Type\PdfDictionary
 
$document : \setasign\SetaPDF2\Core\Document
 

_findLastLeafNode()

protected AbstractTree::_findLastLeafNode (
\setasign\SetaPDF2\Core\Type\PdfDictionary $node,
array &$intermediateNodes,
array &$ensuredObjectsList = array ( )
): bool|\setasign\SetaPDF2\Core\Type\PdfDictionary

Finds the last leaf node.

Parameters
$node : \setasign\SetaPDF2\Core\Type\PdfDictionary
 
$intermediateNodes : array
 
$ensuredObjectsList : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_findLeaveNodeByKey()

protected AbstractTree::_findLeaveNodeByKey (
\setasign\SetaPDF2\Core\Type\PdfDictionary $node,
string|int $key,
bool $exactMatch = true,
array &$intermediateNodes = array ( ),
array &$kidsInfo = array ( ),
array &$ensuredObjectsList = array ( )
): bool|\setasign\SetaPDF2\Core\Type\PdfDictionary

Find an appropriate leaf node by a key.

Parameters
$node : \setasign\SetaPDF2\Core\Type\PdfDictionary
 
$key : string|int
 
$exactMatch : bool
 
$intermediateNodes : array
 
$kidsInfo : array
 
$ensuredObjectsList : array
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_get()

protected AbstractTree::_get (): array|false

Gets a key value pair by a root node and a key.

Parameters
$node : \setasign\SetaPDF2\Core\Type\PdfDictionary
 
$key : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

_getBlankLeafNodeObject()

private AbstractTree::_getBlankLeafNodeObject (
bool $intermediate = false
): \setasign\SetaPDF2\Core\Type\PdfIndirectObject

Helper method to create a blank leaf node

Parameters
$intermediate : bool
 

_getEntriesKeyName()

protected NumberTree::_getEntriesKeyName (
void
): string

Get the entries key name for this implementation.

See

_getKeyClassName()

protected NumberTree::_getKeyClassName (
void
): string

Get the key class name used by this tree implementation.

See

_getKeyInstanceName()

protected AbstractTree::_getKeyInstanceName (
void
): string

Get the key instance name by tree implementation.

_getSortType()

protected NumberTree::_getSortType (
void
): int

Get the sort type for this tree implementation.

See

add()

public AbstractTree::add (): \setasign\SetaPDF2\Core\Type\PdfNumeric|\setasign\SetaPDF2\Core\Type\PdfString

Add a keyed value to the tree.

For name trees: Make sure you pass the name in PDFDocEncoding or UTF-16BE including BOM.

Parameters
$key : int|string|\setasign\SetaPDF2\Core\Type\PdfScalarValueInterface

Depends on the implementation

$value : \setasign\SetaPDF2\Core\Type\AbstractType
 
Exceptions

Throws KeyAlreadyExistsException

Throws \setasign\SetaPDF2\Core\Type\Exception

See

cleanUp()

public AbstractTree::cleanUp (
void
): void

Release objects to free memory and cycled references

After calling this method the instance of this object is unusable!

get()

public AbstractTree::get (
string|int $key,
string $className = null
): \setasign\SetaPDF2\Core\Type\AbstractType|false|mixed

Get an object by a key.

Parameters
$key : string|int
 
$className : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getAll()

public AbstractTree::getAll (
bool $keysOnly = false,
?string $className = null
): array

Get all keyed objects.

Parameters
$keysOnly : bool
 
$className : ?string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getEntriesKeyName()

public AbstractTree::getEntriesKeyName (
void
): string

Get the entries key name.

getValue()

public AbstractTree::getValue (
void
): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the root dictionary entry

See

isNew()

public AbstractTree::isNew (
void
): bool

Checks whether this tree is new or initiated with existing entries.

merge()

public AbstractTree::merge (
AbstractTree $tree,
?callback $alreadyExistsCallback = null
): array

Merges another tree into this tree.

As all items have to be unique this method will call a callback function given in $alreadyExistsCallback if an item already exists.

Parameters
$tree : AbstractTree
 
$alreadyExistsCallback : ?callback

Will be called if an item already exists.
This method can take control over the renaming of the item. The method will be called as long as it will not throw an exception of KeyAlreadyExistsException.
The parameter of the callback function are: The key value and an incremental number of renaming attempts.

Return Values

An array of renamed items

Exceptions

Throws KeyAlreadyExistsException

Throws \setasign\SetaPDF2\Core\Type\Exception

remove()

public AbstractTree::remove (
string $key
): bool

Remove a key from the tree

Parameters
$key : string
 
Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

toPhp()

public AbstractTree::toPhp (
void
): array

Returns an array with named keys and name values

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

See

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