AbstractTableConfigurationTreeDataProvider extends AbstractTreeDataProvider

AbstractYes

An abstract TCA tree data provider

Table of Contents

Properties

$availableItems  : array<string|int, mixed>
$expandAll  : bool
$expandedList  : string
$itemUnselectableList  : array<string|int, mixed>
Contains all ids which are not allowed to be selected
$itemWhiteList  : array<string|int, mixed>
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
$treeData  : TreeNode
$treeId  : string

Methods

getExpandAll()  : bool
Gets the expandAll
getExpandedList()  : string
Gets the list for expanded nodes
getItemUnselectableList()  : array<string|int, mixed>
Getter for $itemUnselectableList
getItemWhiteList()  : array<string|int, mixed>
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
getTreeId()  : string
Gets the id of the tree
initializeTreeData()  : mixed
Read the list for expanded nodes from user settings
setAvailableItems()  : mixed
setExpandAll()  : mixed
Sets the expandAll
setExpandedList()  : mixed
Sets the list for expanded nodes
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
setTreeId()  : mixed
Sets the id of the tree
isExpanded()  : bool
Gets the expanded state of a given node

Properties

$availableItems

protected array<string|int, mixed> $availableItems = []
Internal
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<string|int, mixed> $itemUnselectableList = []

$itemWhiteList

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

protected array<string|int, mixed> $itemWhiteList = []

$levelMaximum

protected int $levelMaximum = 4

$nonSelectableLevelList

protected string $nonSelectableLevelList = '0'

$selectedList

protected string $selectedList = ''

Methods

getExpandAll()

Gets the expandAll

public getExpandAll() : bool
Return values
bool

getExpandedList()

Gets the list for expanded nodes

public getExpandedList() : string
Return values
string

getItemUnselectableList()

Getter for $itemUnselectableList

public getItemUnselectableList() : array<string|int, mixed>
Return values
array<string|int, mixed>

getItemWhiteList()

Getter for the itemWhiteList

public getItemWhiteList() : array<string|int, mixed>
Return values
array<string|int, mixed>

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

getTreeId()

Gets the id of the tree

public getTreeId() : string
Return values
string

initializeTreeData()

Read the list for expanded nodes from user settings

public initializeTreeData() : mixed

setAvailableItems()

public setAvailableItems(array<string|int, mixed> $availableItems) : mixed
Parameters
$availableItems : array<string|int, mixed>
Internal

See property comment

setExpandAll()

Sets the expandAll

public setExpandAll(bool $expandAll) : mixed
Parameters
$expandAll : bool

setExpandedList()

Sets the list for expanded nodes

public setExpandedList(string $expandedList) : mixed
Parameters
$expandedList : string

setItemUnselectableList()

Setter for $itemUnselectableList

public setItemUnselectableList(array<string|int, mixed> $itemUnselectableList) : mixed
Parameters
$itemUnselectableList : array<string|int, mixed>

setItemWhiteList()

Setter for the itemWhiteList

public setItemWhiteList(array<string|int, mixed> $itemWhiteList) : mixed
Parameters
$itemWhiteList : array<string|int, mixed>

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

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

        
    


            

                    

        

    

        

            
Search results