PHP Класс Neos\Neos\Ui\Domain\Service\NodeTreeBuilder

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$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

Открытые методы

Метод Описание
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

Защищенные методы

Метод Описание
isInRootLine ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $haystack = null, TYPO3\TYPO3CR\Domain\Model\NodeInterface $needle )

Описание методов

build() публичный Метод

Build a json serializable tree structure containing node information
public build ( $includeRoot = false, $root = null, $depth = null ) : array
Результат array

getRoot() публичный Метод

Get the root node
public getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
Результат TYPO3\TYPO3CR\Domain\Model\NodeInterface

isInRootLine() защищенный Метод

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() публичный Метод

Set the active node
public setActive ( string $activeContextPath ) : void
$activeContextPath string
Результат void

setControllerContext() публичный Метод

Set the controller context
public setControllerContext ( TYPO3\Flow\Mvc\Controller\ControllerContext $controllerContext ) : void
$controllerContext TYPO3\Flow\Mvc\Controller\ControllerContext
Результат void

setDepth() публичный Метод

Set the depth
public setDepth ( integer $depth )
$depth integer

setNodeTypeFilter() публичный Метод

Set the node type filter
public setNodeTypeFilter ( string $nodeTypeFilter ) : void
$nodeTypeFilter string
Результат void

setRoot() публичный Метод

Set the root node
public setRoot ( string $rootContextPath ) : void
$rootContextPath string
Результат void

setSearchTermFilter() публичный Метод

Set the search term filter
public setSearchTermFilter ( string $searchTermFilter ) : void
$searchTermFilter string
Результат void

Описание свойств

$active защищенное свойство

The currently active node in the tree
protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $active
Результат TYPO3\TYPO3CR\Domain\Model\NodeInterface

$controllerContext защищенное свойство

protected ControllerContext,TYPO3\Flow\Mvc\Controller $controllerContext
Результат TYPO3\Flow\Mvc\Controller\ControllerContext

$depth защищенное свойство

Determines how many levels of the tree should be loaded
protected int $depth
Результат integer

$linkingService защищенное свойство

protected LinkingService,TYPO3\Neos\Service $linkingService
Результат TYPO3\Neos\Service\LinkingService

$nodeService защищенное свойство

protected NodeService,Neos\Neos\Ui\TYPO3CR\Service $nodeService
Результат Neos\Neos\Ui\TYPO3CR\Service\NodeService

$nodeTypeFilter защищенное свойство

An (optional) node type filter
protected string|null $nodeTypeFilter
Результат string | null

$root защищенное свойство

The site node
protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $root
Результат TYPO3\TYPO3CR\Domain\Model\NodeInterface

$searchTermFilter защищенное свойство

An (optional) search term filter
protected string $searchTermFilter
Результат string