TYPO3 CMS  TYPO3_6-2
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 t3lib_tree_Tca_AbstractTcaTreeDataProvider TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider t3lib_tree_Tca_DatabaseTreeDataProvider

Public Member Functions

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

Protected Member Functions

 isExpanded (\TYPO3\CMS\Backend\Tree\TreeNode $node)
 

Protected Attributes

 $expandAll = FALSE
 
 $levelMaximum = 2
 
 $treeData = NULL
 
 $treeId
 
 $nonSelectableLevelList = '0'
 
 $expandedList = ''
 
 $selectedList = ''
 
 $itemWhiteList = array()
 
 $itemUnselectableList = array()
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
 $rootNode = NULL
 

Detailed Description

This file is part of the TYPO3 CMS project.

It is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License, either version 2 of the License, or any later version.

For the full copyright and license information, please read the LICENSE.txt file that was distributed with this source code.

The TYPO3 project - inspiring people to share! An abstract TCA tree data provider

Author
Steffen Ritter info@.nosp@m.stef.nosp@m.fen-r.nosp@m.itte.nosp@m.r.net

Definition at line 21 of file AbstractTableConfigurationTreeDataProvider.php.

Member Function Documentation

◆ getExpandAll()

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

Gets the expamdAll

Returns
boolean

Definition at line 105 of file AbstractTableConfigurationTreeDataProvider.php.

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

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

◆ getExpandedList()

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()

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

Getter for $itemUnselectableList

Returns
array

Definition at line 238 of file AbstractTableConfigurationTreeDataProvider.php.

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

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

◆ getItemWhiteList()

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

Getter for the itemWhiteList

Returns
array

Definition at line 219 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ getLevelMaximum()

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

Gets the levelMaximum

Returns
integer

Definition at line 124 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ getNonSelectableLevelList()

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

Gets the list for non selectable tree levels

Returns
string

Definition at line 200 of file AbstractTableConfigurationTreeDataProvider.php.

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

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

◆ getSelectedList()

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\getTableWhere().

◆ getTreeId()

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

Gets the id of the tree

Returns
string

Definition at line 86 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

Returns
void

Definition at line 162 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ isExpanded()

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

Gets the expanded state of a given node

Parameters
\TYPO3\CMS\Backend\Tree\TreeNode$node
Returns
boolean

Definition at line 134 of file AbstractTableConfigurationTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getExpandAll(), and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

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

◆ setExpandAll()

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

Sets the expandAll

Parameters
boolean$expandAll
Returns
void

Definition at line 96 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
Returns
void

Definition at line 144 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
Returns
void

Definition at line 229 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
Returns
void

Definition at line 210 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
integer$levelMaximum
Returns
void

Definition at line 115 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
Returns
void

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
Returns
void

Definition at line 172 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
Returns
void

Definition at line 77 of file AbstractTableConfigurationTreeDataProvider.php.

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

Member Data Documentation

◆ $expandAll

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

Definition at line 26 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $expandedList

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

Definition at line 51 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $itemUnselectableList

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

Contains all ids which are not allowed to be selected

Definition at line 69 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)

Definition at line 64 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $levelMaximum

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

Definition at line 31 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $nonSelectableLevelList

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

Definition at line 46 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $selectedList

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

Definition at line 56 of file AbstractTableConfigurationTreeDataProvider.php.

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

◆ $treeData

TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider::$treeData = NULL
protected

Definition at line 36 of file AbstractTableConfigurationTreeDataProvider.php.

◆ $treeId

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().