PHP Class Neos\Neos\Ui\Domain\Service\NodeTreeBuilder

Show file Open project: neos/neos-ui Class Usage Examples

Protected Properties

Property	Type	Description
$active	TYPO3\TYPO3CR\Domain\Model\NodeInterface	The currently active node in the tree
$controllerContext	TYPO3\Flow\Mvc\Controller\ControllerContext
$depth	integer	Determines how many levels of the tree should be loaded
$linkingService	TYPO3\Neos\Service\LinkingService
$nodeService	Neos\Neos\Ui\TYPO3CR\Service\NodeService
$nodeTypeFilter	string \| null	An (optional) node type filter
$root	TYPO3\TYPO3CR\Domain\Model\NodeInterface	The site node
$searchTermFilter	string	An (optional) search term filter

Public Methods

Method	Description
build ( $includeRoot = false, $root = null, $depth = null ) : array	Build a json serializable tree structure containing node information
getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface	Get the root node
setActive ( string $activeContextPath ) : void	Set the active node
setControllerContext ( TYPO3\Flow\Mvc\Controller\ControllerContext $controllerContext ) : void	Set the controller context
setDepth ( integer $depth )	Set the depth
setNodeTypeFilter ( string $nodeTypeFilter ) : void	Set the node type filter
setRoot ( string $rootContextPath ) : void	Set the root node
setSearchTermFilter ( string $searchTermFilter ) : void	Set the search term filter

Protected Methods

Method	Description
isInRootLine ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $haystack = null, TYPO3\TYPO3CR\Domain\Model\NodeInterface $needle )

Method Details

build() public method

Build a json serializable tree structure containing node information

public build ( $includeRoot = false, $root = null, $depth = null ) : array
return	array

getRoot() public method

Get the root node

public getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
return	TYPO3\TYPO3CR\Domain\Model\NodeInterface

isInRootLine() protected method

protected isInRootLine ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $haystack = null, TYPO3\TYPO3CR\Domain\Model\NodeInterface $needle )
$haystack	TYPO3\TYPO3CR\Domain\Model\NodeInterface
$needle	TYPO3\TYPO3CR\Domain\Model\NodeInterface

setActive() public method

Set the active node

public setActive ( string $activeContextPath ) : void
$activeContextPath	string
return	void

setControllerContext() public method

Set the controller context

public setControllerContext ( TYPO3\Flow\Mvc\Controller\ControllerContext $controllerContext ) : void
$controllerContext	TYPO3\Flow\Mvc\Controller\ControllerContext
return	void

setDepth() public method

Set the depth

public setDepth ( integer $depth )
$depth	integer

setNodeTypeFilter() public method

Set the node type filter

public setNodeTypeFilter ( string $nodeTypeFilter ) : void
$nodeTypeFilter	string
return	void

setRoot() public method

Set the root node

public setRoot ( string $rootContextPath ) : void
$rootContextPath	string
return	void

setSearchTermFilter() public method

Set the search term filter

public setSearchTermFilter ( string $searchTermFilter ) : void
$searchTermFilter	string
return	void

Property Details

$active protected property

The currently active node in the tree

protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $active
return	TYPO3\TYPO3CR\Domain\Model\NodeInterface

$controllerContext protected property

protected ControllerContext,TYPO3\Flow\Mvc\Controller $controllerContext
return	TYPO3\Flow\Mvc\Controller\ControllerContext

$depth protected property

Determines how many levels of the tree should be loaded

protected int $depth
return	integer

$linkingService protected property

protected LinkingService,TYPO3\Neos\Service $linkingService
return	TYPO3\Neos\Service\LinkingService

$nodeService protected property

protected NodeService,Neos\Neos\Ui\TYPO3CR\Service $nodeService
return	Neos\Neos\Ui\TYPO3CR\Service\NodeService

$nodeTypeFilter protected property

An (optional) node type filter

protected string\|null $nodeTypeFilter
return	string \| null

$root protected property

The site node

protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $root
return	TYPO3\TYPO3CR\Domain\Model\NodeInterface

$searchTermFilter protected property

An (optional) search term filter

protected string $searchTermFilter
return	string