TYPO3  7.6
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DatabaseTreeDataProvider Class Reference
Inheritance diagram for DatabaseTreeDataProvider:
AbstractTableConfigurationTreeDataProvider 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 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 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 AbstractTableConfigurationTreeDataProvider
 isExpanded (\TYPO3\CMS\Backend\Tree\TreeNode $node)
 

Protected Attributes

 $tableName = ''
 
 $treeId = ''
 
 $labelField = ''
 
 $tableWhere = ''
 
 $lookupMode = self::MODE_CHILDREN
 
 $lookupField = ''
 
 $rootUid = 0
 
 $idCache = array()
 
 $columnConfiguration
 
 $nodeSortValues = array()
 
 $generatedTSConfig = array()
 
 $signalSlotDispatcher
 
- Protected Attributes inherited from AbstractTableConfigurationTreeDataProvider
 $expandAll = false
 
 $levelMaximum = 4
 
 $treeData = null
 
 $treeId
 
 $nonSelectableLevelList = '0'
 
 $expandedList = ''
 
 $selectedList = ''
 
 $itemWhiteList = array()
 
 $itemUnselectableList = array()
 
- Protected Attributes inherited from AbstractTreeDataProvider
 $rootNode = null
 

Detailed Description

TCA tree data provider

Definition at line 25 of file DatabaseTreeDataProvider.php.

Member Function Documentation

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 484 of file DatabaseTreeDataProvider.php.

References GeneralUtility\deprecationLog(), and DatabaseTreeDataProvider\getSignalSlotDispatcher().

Referenced by DatabaseTreeDataProvider\emitPostProcessTreeDataSignal().

emitPostProcessTreeDataSignal ( )
protected
getLabelField ( )

Gets the label field

Returns
string

Definition at line 111 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$labelField.

getLookupField ( )

Gets the lookup field

Returns
string

Definition at line 153 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$lookupField.

Referenced by DatabaseTreeDataProvider\initializeTreeData().

getLookupMode ( )

Gets the lookup mode

Returns
int

Definition at line 174 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$lookupMode.

Referenced by DatabaseTreeDataProvider\getRelatedRecords().

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

Get the ObjectManager

Returns

Definition at line 525 of file DatabaseTreeDataProvider.php.

References GeneralUtility\makeInstance().

Referenced by DatabaseTreeDataProvider\getSignalSlotDispatcher().

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 DatabaseTreeDataProvider\getLookupMode(), and DatabaseTreeDataProvider\MODE_PARENT.

getRoot ( )

Gets the root node

Returns

Definition at line 194 of file DatabaseTreeDataProvider.php.

getRootUid ( )

Gets the root uid

Returns
int

Definition at line 215 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$rootUid.

Referenced by DatabaseTreeDataProvider\loadTreeData().

getSignalSlotDispatcher ( )
protected
getTableName ( )
getTableWhere ( )

Gets the tableWhere clause

Returns
string

Definition at line 236 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$tableWhere.

initializeTreeData ( )
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 DatabaseTreeDataProvider\getTableName().

loadTreeData ( )
protected

Loads the tree data (all possible children)

Returns
void

Definition at line 305 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\getRootUid().

Referenced by DatabaseTreeDataProvider\initializeTreeData().

setLabelField (   $labelField)

Sets the label field

Parameters
string$labelField
Returns
void

Definition at line 101 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$labelField.

setLookupField (   $lookupField)

Sets the lookup field

Parameters
string$lookupField
Returns
void

Definition at line 143 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$lookupField.

setLookupMode (   $lookupMode)

Sets the lookup mode

Parameters
int$lookupMode
Returns
void

Definition at line 164 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$lookupMode.

setRootUid (   $rootUid)

Sets the root uid

Parameters
int$rootUid
Returns
void

Definition at line 205 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$rootUid.

setTableName (   $tableName)

Sets the table name

Parameters
string$tableName
Returns
void

Definition at line 122 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$tableName.

setTableWhere (   $tableWhere)

Sets the tableWhere clause

Parameters
string$tableWhere
Returns
void

Definition at line 226 of file DatabaseTreeDataProvider.php.

References DatabaseTreeDataProvider\$tableWhere.

Member Data Documentation

$columnConfiguration
protected

Definition at line 76 of file DatabaseTreeDataProvider.php.

$generatedTSConfig = array()
protected

Definition at line 88 of file DatabaseTreeDataProvider.php.

$idCache = array()
protected

Definition at line 69 of file DatabaseTreeDataProvider.php.

$labelField = ''
protected
$lookupField = ''
protected
$lookupMode = self::MODE_CHILDREN
protected
$nodeSortValues = array()
protected

Definition at line 83 of file DatabaseTreeDataProvider.php.

$rootUid = 0
protected
$signalSlotDispatcher
protected
$tableName = ''
protected
$tableWhere = ''
protected
$treeId = ''
protected

Definition at line 39 of file DatabaseTreeDataProvider.php.

const MODE_CHILDREN = 1

Definition at line 28 of file DatabaseTreeDataProvider.php.

const MODE_PARENT = 2
const SIGNAL_PostProcessTreeData = 'PostProcessTreeData'

Definition at line 27 of file DatabaseTreeDataProvider.php.