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

Afficher le fichier Open project: neos/neos-ui Class Usage Examples

Protected Properties

Свойство 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

Méthodes publiques

Méthode 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

Méthodes protégées

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

Method Details

build() public méthode

Build a json serializable tree structure containing node information
public build ( $includeRoot = false, $root = null, $depth = null ) : array
Résultat array

getRoot() public méthode

Get the root node
public getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
Résultat TYPO3\TYPO3CR\Domain\Model\NodeInterface

isInRootLine() protected méthode

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 méthode

Set the active node
public setActive ( string $activeContextPath ) : void
$activeContextPath string
Résultat void

setControllerContext() public méthode

Set the controller context
public setControllerContext ( TYPO3\Flow\Mvc\Controller\ControllerContext $controllerContext ) : void
$controllerContext TYPO3\Flow\Mvc\Controller\ControllerContext
Résultat void

setDepth() public méthode

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

setNodeTypeFilter() public méthode

Set the node type filter
public setNodeTypeFilter ( string $nodeTypeFilter ) : void
$nodeTypeFilter string
Résultat void

setRoot() public méthode

Set the root node
public setRoot ( string $rootContextPath ) : void
$rootContextPath string
Résultat void

setSearchTermFilter() public méthode

Set the search term filter
public setSearchTermFilter ( string $searchTermFilter ) : void
$searchTermFilter string
Résultat void

Property Details

$active protected_oe property

The currently active node in the tree
protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $active
Résultat TYPO3\TYPO3CR\Domain\Model\NodeInterface

$controllerContext protected_oe property

protected ControllerContext,TYPO3\Flow\Mvc\Controller $controllerContext
Résultat TYPO3\Flow\Mvc\Controller\ControllerContext

$depth protected_oe property

Determines how many levels of the tree should be loaded
protected int $depth
Résultat integer

$linkingService protected_oe property

protected LinkingService,TYPO3\Neos\Service $linkingService
Résultat TYPO3\Neos\Service\LinkingService

$nodeService protected_oe property

protected NodeService,Neos\Neos\Ui\TYPO3CR\Service $nodeService
Résultat Neos\Neos\Ui\TYPO3CR\Service\NodeService

$nodeTypeFilter protected_oe property

An (optional) node type filter
protected string|null $nodeTypeFilter
Résultat string | null

$root protected_oe property

The site node
protected NodeInterface,TYPO3\TYPO3CR\Domain\Model $root
Résultat TYPO3\TYPO3CR\Domain\Model\NodeInterface

$searchTermFilter protected_oe property

An (optional) search term filter
protected string $searchTermFilter
Résultat string