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

Public Member Functions

 __construct (protected EventDispatcherInterface $eventDispatcher)
 
 setLabelField (string $labelField)
 
 getLabelField ()
 
 setTableName (string $tableName)
 
 getTableName ()
 
 setLookupField (string $lookupField)
 
 getLookupField ()
 
 setLookupMode (int $lookupMode)
 
self::MODE_ * getLookupMode ()
 
 getNodes (TreeNode $node)
 
 getRoot ()
 
 setStartingPoints (array $startingPoints)
 
int[] getStartingPoints ()
 
 setTableWhere (string $tableWhere)
 
 getTableWhere ()
 
 initializeTreeData ()
 
- ‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
 setTreeId ($treeId)
 
string getTreeId ()
 
 setExpandAll ($expandAll)
 
bool getExpandAll ()
 
 setLevelMaximum ($levelMaximum)
 
int getLevelMaximum ()
 
 setSelectedList ($selectedList)
 
string getSelectedList ()
 
 setNonSelectableLevelList ($nonSelectableLevelList)
 
string getNonSelectableLevelList ()
 
 setItemWhiteList (array $itemWhiteList)
 
array getItemWhiteList ()
 
 setItemUnselectableList (array $itemUnselectableList)
 
array getItemUnselectableList ()
 
 setAvailableItems (array $availableItems)
 

Public Attributes

const MODE_CHILDREN = 1
 
const MODE_PARENT = 2
 

Protected Member Functions

 buildRepresentationForNode (TreeNode $basicNode, ?DatabaseTreeNode $parent=null, $level=0)
 
 loadTreeData ()
 
 getChildrenOf (TreeNode $node, int $level)
 
 getRelatedRecords (array $row)
 
 getChildrenUidsFromParentRelation (array $row)
 
 getChildrenUidsFromChildrenRelation (array $row)
 
int[] listFieldQuery (string $fieldName, int $queryId)
 
 getLanguageService ()
 
- ‪Protected Member Functions inherited from ‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
bool isExpanded (TreeNode $node)
 

Protected Attributes

string $tableName = ''
 
string $treeId = ''
 
string $labelField = ''
 
string $tableWhere = ''
 
int $lookupMode = self::MODE_CHILDREN
 
string $lookupField = ''
 
array $startingPoints = [0]
 
array $idCache = []
 
array $columnConfiguration
 
array $nodeSortValues = []
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
bool $expandAll = false
 
int $levelMaximum = 4
 
TreeNode $treeData
 
string $treeId
 
string $nonSelectableLevelList = '0'
 
string $expandedList = ''
 
string $selectedList = ''
 
array $itemWhiteList = array( )
 
mixed[] $itemUnselectableList = array( )
 
array $availableItems = []
 
- ‪Protected Attributes inherited from ‪TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
TreeNode $rootNode
 

Detailed Description

TCA tree data provider

Definition at line 38 of file DatabaseTreeDataProvider.php.

Constructor & Destructor Documentation

◆ __construct()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::__construct ( protected EventDispatcherInterface  $eventDispatcher)

Definition at line 81 of file DatabaseTreeDataProvider.php.

Member Function Documentation

◆ buildRepresentationForNode()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::buildRepresentationForNode ( TreeNode  $basicNode,
?DatabaseTreeNode  $parent = null,
  $level = 0 
)
protected

Builds a complete node including children

Definition at line 203 of file DatabaseTreeDataProvider.php.

References $GLOBALS, TYPO3\CMS\Backend\Tree\TreeNode\getAdditionalData(), TYPO3\CMS\Backend\Tree\TreeNode\getChildNodes(), TYPO3\CMS\Backend\Tree\TreeNode\getId(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLanguageService(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getNonSelectableLevelList(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getSelectedList(), TYPO3\CMS\Backend\Tree\TreeNode\hasChildNodes(), and TYPO3\CMS\Core\Utility\GeneralUtility\inList().

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

◆ getChildrenOf()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getChildrenOf ( TreeNode  $node,
int  $level 
)
protected

Gets node children

Definition at line 305 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Backend\Tree\TreeNode\getId(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRelatedRecords(), TYPO3\CMS\Backend\Tree\TreeNode\setChildNodes(), and TYPO3\CMS\Backend\Tree\TreeNode\setId().

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

◆ getChildrenUidsFromChildrenRelation()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getChildrenUidsFromChildrenRelation ( array  $row)
protected

Gets related children records depending on TCA configuration

Definition at line 405 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Webhooks\Message\$uid, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), and TYPO3\CMS\Core\Database\Connection\PARAM_INT.

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

◆ getChildrenUidsFromParentRelation()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getChildrenUidsFromParentRelation ( array  $row)
protected

Gets related records depending on TCA configuration

Definition at line 364 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Webhooks\Message\$uid, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\listFieldQuery().

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

◆ getLabelField()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getLabelField ( )

Gets the label field

Definition at line 94 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$labelField.

◆ getLanguageService()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getLanguageService ( )
protected

Definition at line 486 of file DatabaseTreeDataProvider.php.

References $GLOBALS.

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

◆ getLookupField()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getLookupField ( )

Gets the lookup field

Definition at line 126 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$lookupField.

◆ getLookupMode()

self::MODE_* TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getLookupMode ( )

Gets the lookup mode

Returns
‪self::MODE_*

Definition at line 146 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$lookupMode.

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

◆ getNodes()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getNodes ( TreeNode  $node)

Gets the nodes

Definition at line 154 of file DatabaseTreeDataProvider.php.

◆ getRelatedRecords()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getRelatedRecords ( array  $row)
protected

Gets related records depending on TCA configuration

Definition at line 344 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenUidsFromChildrenRelation(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenUidsFromParentRelation(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupMode().

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

◆ getRoot()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getRoot ( )

Gets the root node

Reimplemented from TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider.

Definition at line 159 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\buildRepresentationForNode().

◆ getStartingPoints()

int [] TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getStartingPoints ( )

Gets the root uids

Returns
‪int[]

Definition at line 179 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$startingPoints.

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

◆ getTableName()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getTableName ( )

Gets the table name

Definition at line 110 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$tableName.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenUidsFromChildrenRelation(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenUidsFromParentRelation(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\initializeTreeData(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\listFieldQuery().

◆ getTableWhere()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::getTableWhere ( )

Gets the tableWhere clause

Definition at line 195 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$tableWhere.

◆ initializeTreeData()

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

Init the tree data

Reimplemented from TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider.

Definition at line 243 of file DatabaseTreeDataProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$lookupField, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\loadTreeData().

◆ listFieldQuery()

int [] TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::listFieldQuery ( string  $fieldName,
int  $queryId 
)
protected

Queries the table for a field which might contain a list.

Parameters
string$fieldName‪the name of the field to be queried
int$queryId‪the uid to search for
Returns
‪int[] all uids found

Definition at line 462 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName().

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

◆ loadTreeData()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::loadTreeData ( )
protected

Loads the tree data (all possible children)

Definition at line 259 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$startingPoints, TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\$treeData, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getChildrenOf(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getStartingPoints(), TYPO3\CMS\Backend\Tree\TreeNode\setChildNodes(), and TYPO3\CMS\Backend\Tree\TreeNode\setId().

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

◆ setLabelField()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setLabelField ( string  $labelField)

Sets the label field

Definition at line 86 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$labelField.

◆ setLookupField()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setLookupField ( string  $lookupField)

Sets the lookup field

Definition at line 118 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$lookupField.

◆ setLookupMode()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setLookupMode ( int  $lookupMode)

Sets the lookup mode

Parameters
self::MODE_*‪$lookupMode

Definition at line 136 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$lookupMode.

◆ setStartingPoints()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setStartingPoints ( array  $startingPoints)

Sets the root uids

Parameters
int[]$startingPoints

Definition at line 169 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$startingPoints.

◆ setTableName()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setTableName ( string  $tableName)

Sets the table name

Definition at line 102 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$tableName.

◆ setTableWhere()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setTableWhere ( string  $tableWhere)

Sets the tableWhere clause

Definition at line 187 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$tableWhere.

Member Data Documentation

◆ $columnConfiguration

array TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$columnConfiguration
protected

Definition at line 72 of file DatabaseTreeDataProvider.php.

◆ $idCache

array TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$idCache = []
protected

Definition at line 65 of file DatabaseTreeDataProvider.php.

◆ $labelField

string TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$labelField = ''
protected

Definition at line 49 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLabelField(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setLabelField().

◆ $lookupField

string TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$lookupField = ''
protected

Definition at line 58 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupField(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\initializeTreeData(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setLookupField().

◆ $lookupMode

int TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$lookupMode = self::MODE_CHILDREN
protected

Definition at line 56 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupMode(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setLookupMode().

◆ $nodeSortValues

array TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$nodeSortValues = []
protected

Definition at line 79 of file DatabaseTreeDataProvider.php.

◆ $startingPoints

array TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$startingPoints = [0]
protected

Definition at line 63 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getStartingPoints(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\loadTreeData(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setStartingPoints().

◆ $tableName

string TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$tableName = ''
protected

Definition at line 43 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setTableName().

◆ $tableWhere

string TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$tableWhere = ''
protected

Definition at line 51 of file DatabaseTreeDataProvider.php.

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

◆ $treeId

string TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$treeId = ''
protected

Definition at line 47 of file DatabaseTreeDataProvider.php.

◆ MODE_CHILDREN

const TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::MODE_CHILDREN = 1

Definition at line 40 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\TreeDataProviderFactory\getDataProvider().

◆ MODE_PARENT

const TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::MODE_PARENT = 2

Definition at line 41 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\TreeDataProviderFactory\getDataProvider().