‪TYPO3CMS  10.4
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider Class Reference
Inheritance diagram for TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider:
TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider

Public Member Functions

 setTreeId ($treeId)
 
string getTreeId ()
 
 setExpandAll ($expandAll)
 
bool getExpandAll ()
 
 setLevelMaximum ($levelMaximum)
 
int getLevelMaximum ()
 
 setExpandedList ($expandedList)
 
string getExpandedList ()
 
 initializeTreeData ()
 
 setSelectedList ($selectedList)
 
string getSelectedList ()
 
 setNonSelectableLevelList ($nonSelectableLevelList)
 
string getNonSelectableLevelList ()
 
 setItemWhiteList (array $itemWhiteList)
 
array getItemWhiteList ()
 
 setItemUnselectableList (array $itemUnselectableList)
 
array getItemUnselectableList ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
TYPO3 CMS Backend Tree TreeNode getRoot ()
 
TYPO3 CMS Backend Tree TreeNodeCollection getNodes (TreeNode $node)
 

Protected Member Functions

bool isExpanded (TreeNode $node)
 

Protected Attributes

bool $expandAll = false
 
int $levelMaximum = 4
 
TYPO3 CMS Backend Tree TreeNode $treeData
 
string $treeId
 
string $nonSelectableLevelList = '0'
 
string $expandedList = ''
 
string $selectedList = ''
 
array $itemWhiteList = array( )
 
mixed[] $itemUnselectableList = array( )
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
TYPO3 CMS Backend Tree TreeNode $rootNode
 

Detailed Description

An abstract TCA tree data provider

Definition at line 25 of file AbstractTableConfigurationTreeDataProvider.php.

Member Function Documentation

◆ getExpandAll()

bool TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getExpandAll ( )

Gets the expandAll

Returns
‪bool

Definition at line 102 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandAll.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\isExpanded().

◆ getExpandedList()

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getExpandedList ( )

Gets the list for expanded nodes

Returns
‪string

Definition at line 153 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandedList.

◆ getItemUnselectableList()

array TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getItemUnselectableList ( )

Getter for $itemUnselectableList

Returns
‪array

Definition at line 241 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemUnselectableList.

◆ getItemWhiteList()

array TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getItemWhiteList ( )

Getter for the itemWhiteList

Returns
‪array

Definition at line 221 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemWhiteList.

◆ getLevelMaximum()

int TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getLevelMaximum ( )

Gets the levelMaximum

Returns
‪int

Definition at line 122 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$levelMaximum.

◆ getNonSelectableLevelList()

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getNonSelectableLevelList ( )

Gets the list for non selectable tree levels

Returns
‪string

Definition at line 201 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$nonSelectableLevelList.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode().

◆ getSelectedList()

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getSelectedList ( )

Gets the list for selected nodes

Returns
‪string

Definition at line 181 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$selectedList.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode().

◆ getTreeId()

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::getTreeId ( )

Gets the id of the tree

Returns
‪string

Definition at line 82 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeId.

◆ initializeTreeData()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::initializeTreeData ( )

Read the list for expanded nodes from user settings

Reimplemented in TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider.

Definition at line 161 of file AbstractTableConfigurationTreeDataProvider.php.

References $GLOBALS, and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeId.

◆ isExpanded()

bool TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::isExpanded ( TreeNode  $node)
protected

Gets the expanded state of a given node

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode$node
Returns
‪bool

Definition at line 133 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getExpandAll(), and TYPO3\CMS\Backend\Tree\TreeNode\getId().

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode().

◆ setExpandAll()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setExpandAll (   $expandAll)

Sets the expandAll

Parameters
bool$expandAll

Definition at line 92 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandAll.

◆ setExpandedList()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setExpandedList (   $expandedList)

Sets the list for expanded nodes

Parameters
string$expandedList

Definition at line 143 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$expandedList.

◆ setItemUnselectableList()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setItemUnselectableList ( array  $itemUnselectableList)

Setter for $itemUnselectableList

Parameters
array$itemUnselectableList

Definition at line 231 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemUnselectableList.

◆ setItemWhiteList()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setItemWhiteList ( array  $itemWhiteList)

Setter for the itemWhiteList

Parameters
array$itemWhiteList

Definition at line 211 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$itemWhiteList.

◆ setLevelMaximum()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setLevelMaximum (   $levelMaximum)

Sets the levelMaximum

Parameters
int$levelMaximum

Definition at line 112 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$levelMaximum.

◆ setNonSelectableLevelList()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setNonSelectableLevelList (   $nonSelectableLevelList)

Sets the list for non selectable tree levels

Parameters
string$nonSelectableLevelList

Definition at line 191 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$nonSelectableLevelList.

◆ setSelectedList()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setSelectedList (   $selectedList)

Sets the list for selected nodes

Parameters
string$selectedList

Definition at line 171 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$selectedList.

◆ setTreeId()

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::setTreeId (   $treeId)

Sets the id of the tree

Parameters
string$treeId

Definition at line 72 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeId.

Member Data Documentation

◆ $expandAll

bool TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$expandAll = false
protected

Definition at line 29 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getExpandAll(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setExpandAll().

◆ $expandedList

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$expandedList = ''
protected

Definition at line 49 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getExpandedList(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setExpandedList().

◆ $itemUnselectableList

mixed [] TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$itemUnselectableList = array( )
protected

Contains all ids which are not allowed to be selected

Definition at line 65 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getItemUnselectableList(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setItemUnselectableList().

◆ $itemWhiteList

array TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$itemWhiteList = array( )
protected

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

$itemWhiteList

Definition at line 60 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getItemWhiteList(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setItemWhiteList().

◆ $levelMaximum

int TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$levelMaximum = 4
protected

Definition at line 33 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getLevelMaximum(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setLevelMaximum().

◆ $nonSelectableLevelList

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$nonSelectableLevelList = '0'
protected

Definition at line 45 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getNonSelectableLevelList(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setNonSelectableLevelList().

◆ $selectedList

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$selectedList = ''
protected

Definition at line 53 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getSelectedList(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setSelectedList().

◆ $treeData

TYPO3 CMS Backend Tree TreeNode TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$treeData
protected

Definition at line 37 of file AbstractTableConfigurationTreeDataProvider.php.

◆ $treeId

string TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$treeId
protected

Definition at line 41 of file AbstractTableConfigurationTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getTreeId(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\initializeTreeData(), and TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\setTreeId().