AbstractTableConfigurationTreeDataProvider

abstract class \TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider

Extends
AbstractTreeDataProvider

An abstract TCA tree data provider

Table of Contents

Properties

$availableItems  : array
$expandAll  : bool
$expandedList  : string
$itemUnselectableList  : array
Contains all ids which are not allowed to be selected
$itemWhiteList  : array
Contains all ids which may be allowed to display according to beUser Rights and foreign_table_where (if type db)
$levelMaximum  : int
$nonSelectableLevelList  : string
$rootNode  : TreeNode
Root Node
$selectedList  : string
$startingPoints  : int[]
$treeData  : TreeNode
$treeId  : string

Methods

getExpandAll()  : bool
Gets the expandAll
getItemUnselectableList()  : array
Getter for $itemUnselectableList
getItemWhiteList()  : array
Getter for the itemWhiteList
getLevelMaximum()  : int
Gets the levelMaximum
getNonSelectableLevelList()  : string
Gets the list for non selectable tree levels
getRoot()  : TreeNode
Returns the root node
getSelectedList()  : string
Gets the list for selected nodes
getStartingPoints()  : int[]
getTreeId()  : string
Gets the id of the tree
initializeTreeData()  : mixed
Init the tree data
setAvailableItems()  : mixed
setExpandAll()  : mixed
Sets the expandAll
setItemUnselectableList()  : mixed
Setter for $itemUnselectableList
setItemWhiteList()  : mixed
Setter for the itemWhiteList
setLevelMaximum()  : mixed
Sets the levelMaximum
setNonSelectableLevelList()  : mixed
Sets the list for non selectable tree levels
setSelectedList()  : mixed
Sets the list for selected nodes
setStartingPoints()  : void
setTreeId()  : mixed
Sets the id of the tree
isExpanded()  : bool
Gets the expanded state of a given node

Properties

$availableItems

protected array $availableItems = []

Tags

todo:

This is a hack to speed up category tree calculation. See the comments in TcaCategory and AbstractItemProvider FormEngine classes.

$expandAll

protected bool $expandAll = false

$expandedList

protected string $expandedList = ''

$itemUnselectableList

Contains all ids which are not allowed to be selected

protected array $itemUnselectableList = []

$itemWhiteList

Contains all ids which may be allowed to display according to beUser Rights and foreign_table_where (if type db)

protected array $itemWhiteList = []

$levelMaximum

protected int $levelMaximum = 4

$nonSelectableLevelList

protected string $nonSelectableLevelList = '0'

$selectedList

protected string $selectedList = ''

$startingPoints

protected int[] $startingPoints = [0]

Methods

getExpandAll()

Gets the expandAll

public getExpandAll() : bool

Return values

bool

getItemUnselectableList()

Getter for $itemUnselectableList

public getItemUnselectableList() : array

Return values

array

getItemWhiteList()

Getter for the itemWhiteList

public getItemWhiteList() : array

Return values

array

getLevelMaximum()

Gets the levelMaximum

public getLevelMaximum() : int

Return values

int

getNonSelectableLevelList()

Gets the list for non selectable tree levels

public getNonSelectableLevelList() : string

Return values

string

getSelectedList()

Gets the list for selected nodes

public getSelectedList() : string

Return values

string

getStartingPoints()

public getStartingPoints() : int[]

Return values

int[]

getTreeId()

Gets the id of the tree

public getTreeId() : string

Return values

string

initializeTreeData()

Init the tree data

public initializeTreeData() : mixed

setAvailableItems()

public setAvailableItems(array $availableItems) : mixed

Parameters

$availableItems : array

setExpandAll()

Sets the expandAll

public setExpandAll(bool $expandAll) : mixed

Parameters

$expandAll : bool

setItemUnselectableList()

Setter for $itemUnselectableList

public setItemUnselectableList(array $itemUnselectableList) : mixed

Parameters

$itemUnselectableList : array

setItemWhiteList()

Setter for the itemWhiteList

public setItemWhiteList(array $itemWhiteList) : mixed

Parameters

$itemWhiteList : array

setLevelMaximum()

Sets the levelMaximum

public setLevelMaximum(int $levelMaximum) : mixed

Parameters

$levelMaximum : int

setNonSelectableLevelList()

Sets the list for non selectable tree levels

public setNonSelectableLevelList(string $nonSelectableLevelList) : mixed

Parameters

$nonSelectableLevelList : string

setSelectedList()

Sets the list for selected nodes

public setSelectedList(string $selectedList) : mixed

Parameters

$selectedList : string

setStartingPoints()

public setStartingPoints(int[] $startingPoints) : void

Parameters

$startingPoints : int[]

setTreeId()

Sets the id of the tree

public setTreeId(string $treeId) : mixed

Parameters

$treeId : string

isExpanded()

Gets the expanded state of a given node

protected isExpanded(TreeNode $node) : bool

Parameters

$node : TreeNode

Return values

bool
On this page