TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection Class Reference

Inheritance diagram for TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection:

Public Member Functions
	contains (\TYPO3\CMS\Backend\Tree\TreeNode $node)
	append ($node)
Public Member Functions inherited from TYPO3\CMS\Backend\Tree\TreeNodeCollection
	__construct (array $data=[])
	asort ()
	nodeCompare (\TYPO3\CMS\Backend\Tree\TreeNode $node, \TYPO3\CMS\Backend\Tree\TreeNode $otherNode)
	serialize ()
	unserialize ($serializedString)
	toArray ()
	dataFromArray ($data)

Protected Member Functions
	offsetOf (\TYPO3\CMS\Backend\Tree\TreeNode $node)
	binarySearch (\TYPO3\CMS\Backend\Tree\TreeNode $node, $start, $end)
	normalize ()

Detailed Description

Sorted Tree Node Collection

Note: This collection works only with integers as offset keys and not with much datasets. You have been warned!

Definition at line 23 of file SortedTreeNodeCollection.php.

Member Function Documentation

append()

TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection::append

(

$node

)

Adds a node to the internal list in a sorted approach

Parameters

\TYPO3\CMS\Backend\Tree\TreeNode

$node

Returns

void

Definition at line 97 of file SortedTreeNodeCollection.php.

References TYPO3\CMS\Backend\Tree\TreeNodeCollection\asort(), and TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\normalize().

binarySearch()

TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection::binarySearch ( \TYPO3\CMS\Backend\Tree\TreeNode  $node,   $start,   $end  )

protected

Binary search that returns the offset of a given node

Parameters

\TYPO3\CMS\Backend\Tree\TreeNode	$node
int	$start
int	$end

Returns

int

Definition at line 55 of file SortedTreeNodeCollection.php.

Referenced by TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\offsetOf().

contains()

TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection::contains

(

\TYPO3\CMS\Backend\Tree\TreeNode

$node

)

Checks if a specific node is inside the collection

Parameters

\TYPO3\CMS\Backend\Tree\TreeNode

$node

Returns

bool

Definition at line 31 of file SortedTreeNodeCollection.php.

References TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\offsetOf().

normalize()

TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection::normalize ( )

protected

Normalizes the array by reordering the keys

Returns

void

Definition at line 82 of file SortedTreeNodeCollection.php.

Referenced by TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\append().

offsetOf()

TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection::offsetOf ( \TYPO3\CMS\Backend\Tree\TreeNode  $node )

protected

Returns the offset key of given node

Parameters

\TYPO3\CMS\Backend\Tree\TreeNode

$node

Returns

int

Definition at line 42 of file SortedTreeNodeCollection.php.

References TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\binarySearch().

Referenced by TYPO3\CMS\Backend\Tree\SortedTreeNodeCollection\contains().