PHP Class Neos\Neos\Ui\Domain\Dto\LoadTreeDto

Show file Open project: neos/neos-ui

Protected Properties

Property Type Description
$active TYPO3\TYPO3CR\Domain\Model\NodeInterface The currently active node in the tree
$depth integer Determines how many levels of the tree should be loaded
$nodeTypeFilter TYPO3\TYPO3CR\Domain\Model\NodeType | null An (optional) node type filter
$searchTermFilter string An (optional) search term filter

Public Methods

Method Description
getActive ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface Get the active node
getDepth ( ) : integer Get the depth
getNodeTypeFilter ( ) : TYPO3\TYPO3CR\Domain\Model\NodeType | null Get the node type filter
getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface Get the root node
getSearchTermFilter ( ) : string Get the search term filter
setActive ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $active ) : void Set the active node
setDepth ( integer $depth ) Set the depth
setNodeTypeFilter ( TYPO3\TYPO3CR\Domain\Model\NodeType $nodeTypeFilter ) : void Set the node type filter
setSearchTermFilter ( string $searchTermFilter ) : void Set the search term filter

Method Details

getActive() public method

Get the active node
public getActive ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
return TYPO3\TYPO3CR\Domain\Model\NodeInterface

getDepth() public method

Get the depth
public getDepth ( ) : integer
return integer

getNodeTypeFilter() public method

Get the node type filter
public getNodeTypeFilter ( ) : TYPO3\TYPO3CR\Domain\Model\NodeType | null
return TYPO3\TYPO3CR\Domain\Model\NodeType | null

getRoot() public method

Get the root node
public getRoot ( ) : TYPO3\TYPO3CR\Domain\Model\NodeInterface
return TYPO3\TYPO3CR\Domain\Model\NodeInterface

getSearchTermFilter() public method

Get the search term filter
public getSearchTermFilter ( ) : string
return string

setActive() public method

Set the active node
public setActive ( TYPO3\TYPO3CR\Domain\Model\NodeInterface $active ) : void
$active TYPO3\TYPO3CR\Domain\Model\NodeInterface
return void

setDepth() public method

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

setNodeTypeFilter() public method

Set the node type filter
public setNodeTypeFilter ( TYPO3\TYPO3CR\Domain\Model\NodeType $nodeTypeFilter ) : void
$nodeTypeFilter TYPO3\TYPO3CR\Domain\Model\NodeType
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

$depth protected property

Determines how many levels of the tree should be loaded
protected int $depth
return integer

$nodeTypeFilter protected property

An (optional) node type filter
protected NodeType,TYPO3\TYPO3CR\Domain\Model|null $nodeTypeFilter
return TYPO3\TYPO3CR\Domain\Model\NodeType | null

$searchTermFilter protected property

An (optional) search term filter
protected string $searchTermFilter
return string