TYPO3 CMS  TYPO3_7-6
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

 setLabelField ($labelField)
 
 getLabelField ()
 
 setTableName ($tableName)
 
 getTableName ()
 
 setLookupField ($lookupField)
 
 getLookupField ()
 
 setLookupMode ($lookupMode)
 
 getLookupMode ()
 
 getNodes (\TYPO3\CMS\Backend\Tree\TreeNode $node)
 
 getRoot ()
 
 setRootUid ($rootUid)
 
 getRootUid ()
 
 setTableWhere ($tableWhere)
 
 getTableWhere ()
 
 initializeTreeData ()
 
- Public Member Functions inherited from TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
 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)
 

Public Attributes

const SIGNAL_PostProcessTreeData = 'PostProcessTreeData'
 
const MODE_CHILDREN = 1
 
const MODE_PARENT = 2
 

Protected Member Functions

 loadTreeData ()
 
 getRelatedRecords (array $row)
 
 listFieldQuery ($fieldName, $queryId)
 
 emitPostProcessTreeDataSignal ()
 
 emitDeprecatedPostProcessTreeDataSignal ()
 
 getSignalSlotDispatcher ()
 
 getObjectManager ()
 
- Protected Member Functions inherited from TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
 isExpanded (\TYPO3\CMS\Backend\Tree\TreeNode $node)
 

Protected Attributes

 $tableName = ''
 
 $treeId = ''
 
 $labelField = ''
 
 $tableWhere = ''
 
 $lookupMode = self::MODE_CHILDREN
 
 $lookupField = ''
 
 $rootUid = 0
 
 $idCache = []
 
 $columnConfiguration
 
 $nodeSortValues = []
 
 $generatedTSConfig = []
 
 $signalSlotDispatcher
 
- Protected Attributes inherited from TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider
 $expandAll = false
 
 $levelMaximum = 4
 
 $treeData = null
 
 $treeId
 
 $nonSelectableLevelList = '0'
 
 $expandedList = ''
 
 $selectedList = ''
 
 $itemWhiteList = []
 
 $itemUnselectableList = []
 
- Protected Attributes inherited from TYPO3\CMS\Backend\Tree\AbstractTreeDataProvider
 $rootNode = null
 

Detailed Description

TCA tree data provider

Definition at line 25 of file DatabaseTreeDataProvider.php.

Member Function Documentation

◆ emitDeprecatedPostProcessTreeDataSignal()

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

A wrong signal name was introduced with https://review.typo3.org/#/c/34855/ This function handles the old signal name and logs a deprecation warning.

Returns
void
Deprecated:
since TYPO3 CMS 7, will be removed in TYPO3 CMS 8

Definition at line 486 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\deprecationLog(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getSignalSlotDispatcher().

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

◆ emitPostProcessTreeDataSignal()

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

Emits the post processing tree data signal.

Returns
void

Definition at line 470 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\emitDeprecatedPostProcessTreeDataSignal(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getSignalSlotDispatcher().

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

◆ getLabelField()

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

Gets the label field

Returns
string

Definition at line 111 of file DatabaseTreeDataProvider.php.

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

◆ getLookupField()

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

Gets the lookup field

Returns
string

Definition at line 153 of file DatabaseTreeDataProvider.php.

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

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRelatedRecords(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\initializeTreeData(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\loadTreeData().

◆ getLookupMode()

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

Gets the lookup mode

Returns
int

Definition at line 174 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 ( \TYPO3\CMS\Backend\Tree\TreeNode  $node)

Gets the nodes

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

Definition at line 185 of file DatabaseTreeDataProvider.php.

◆ getObjectManager()

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

Get the ObjectManager

Returns

Definition at line 527 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ getRelatedRecords()

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

Gets related records depending on TCA configuration

Parameters
array$row
Returns
array

Definition at line 362 of file DatabaseTreeDataProvider.php.

References $GLOBALS, $uid, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupField(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupMode(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), TYPO3\CMS\Core\Utility\GeneralUtility\intExplode(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\listFieldQuery(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ getRoot()

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

Gets the root node

Returns

Definition at line 194 of file DatabaseTreeDataProvider.php.

◆ getRootUid()

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

Gets the root uid

Returns
int

Definition at line 215 of file DatabaseTreeDataProvider.php.

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

Referenced by TYPO3\CMS\Backend\Security\CategoryPermissionsAspect\__construct(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\loadTreeData().

◆ getSignalSlotDispatcher()

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

Get the SignalSlot dispatcher

Returns

Definition at line 514 of file DatabaseTreeDataProvider.php.

References TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$signalSlotDispatcher, and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getObjectManager().

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\emitDeprecatedPostProcessTreeDataSignal(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\emitPostProcessTreeDataSignal().

◆ getTableName()

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

Gets the table name

Returns
string

Definition at line 132 of file DatabaseTreeDataProvider.php.

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

Referenced by TYPO3\CMS\Backend\Security\CategoryPermissionsAspect\__construct(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRelatedRecords(), 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

Returns
string

Definition at line 236 of file DatabaseTreeDataProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\$tableWhere, TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getItemUnselectableList(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getNonSelectableLevelList(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordTitle(), TYPO3\CMS\Backend\Utility\BackendUtility\getRecordWSOL(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\getSelectedList(), TYPO3\CMS\Core\Utility\GeneralUtility\inList(), TYPO3\CMS\Core\Tree\TableConfiguration\AbstractTableConfigurationTreeDataProvider\isExpanded(), TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance(), and TYPO3\CMS\Core\Imaging\Icon\SIZE_SMALL.

◆ initializeTreeData()

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

Init the tree data

Returns
void

Definition at line 287 of file DatabaseTreeDataProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\emitPostProcessTreeDataSignal(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupField(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getTableName(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\loadTreeData(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

◆ listFieldQuery()

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

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

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

Definition at line 453 of file DatabaseTreeDataProvider.php.

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

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

◆ loadTreeData()

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

Loads the tree data (all possible children)

Returns
void

Definition at line 305 of file DatabaseTreeDataProvider.php.

References $GLOBALS, TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getLookupField(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRelatedRecords(), TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRootUid(), and TYPO3\CMS\Core\Utility\GeneralUtility\makeInstance().

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

◆ setLabelField()

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

Sets the label field

Parameters
string$labelField
Returns
void

Definition at line 101 of file DatabaseTreeDataProvider.php.

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

◆ setLookupField()

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

Sets the lookup field

Parameters
string$lookupField
Returns
void

Definition at line 143 of file DatabaseTreeDataProvider.php.

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

◆ setLookupMode()

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

Sets the lookup mode

Parameters
int$lookupMode
Returns
void

Definition at line 164 of file DatabaseTreeDataProvider.php.

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

◆ setRootUid()

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::setRootUid (   $rootUid)

Sets the root uid

Parameters
int$rootUid
Returns
void

Definition at line 205 of file DatabaseTreeDataProvider.php.

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

◆ setTableName()

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

Sets the table name

Parameters
string$tableName
Returns
void

Definition at line 122 of file DatabaseTreeDataProvider.php.

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

◆ setTableWhere()

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

Sets the tableWhere clause

Parameters
string$tableWhere
Returns
void

Definition at line 226 of file DatabaseTreeDataProvider.php.

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

Member Data Documentation

◆ $columnConfiguration

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

Definition at line 76 of file DatabaseTreeDataProvider.php.

◆ $generatedTSConfig

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

Definition at line 88 of file DatabaseTreeDataProvider.php.

◆ $idCache

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

Definition at line 69 of file DatabaseTreeDataProvider.php.

◆ $labelField

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

Definition at line 44 of file DatabaseTreeDataProvider.php.

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

◆ $lookupField

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

Definition at line 59 of file DatabaseTreeDataProvider.php.

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

◆ $lookupMode

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

Definition at line 54 of file DatabaseTreeDataProvider.php.

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

◆ $nodeSortValues

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

Definition at line 83 of file DatabaseTreeDataProvider.php.

◆ $rootUid

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$rootUid = 0
protected

Definition at line 64 of file DatabaseTreeDataProvider.php.

Referenced by TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\getRootUid(), and TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider\setRootUid().

◆ $signalSlotDispatcher

TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::$signalSlotDispatcher
protected

Definition at line 93 of file DatabaseTreeDataProvider.php.

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

◆ $tableName

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

Definition at line 34 of file DatabaseTreeDataProvider.php.

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

◆ $tableWhere

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

Definition at line 49 of file DatabaseTreeDataProvider.php.

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

◆ $treeId

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

Definition at line 39 of file DatabaseTreeDataProvider.php.

◆ MODE_CHILDREN

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

Definition at line 28 of file DatabaseTreeDataProvider.php.

◆ MODE_PARENT

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

Definition at line 29 of file DatabaseTreeDataProvider.php.

◆ SIGNAL_PostProcessTreeData

const TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider::SIGNAL_PostProcessTreeData = 'PostProcessTreeData'

Definition at line 27 of file DatabaseTreeDataProvider.php.