DatabaseTreeDataProvider.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tree\TableConfiguration;

use TYPO3\CMS\Backend\Utility\BackendUtility;
use TYPO3\CMS\Core\Utility\GeneralUtility;

class DatabaseTreeDataProvider extends AbstractTableConfigurationTreeDataProvider {

    const SIGNAL_PostProcessTreeData = 'PostProcessTreeData';
    const MODE_CHILDREN = 1;
    const MODE_PARENT = 2;
    protected $tableName = '';

    protected $treeId = '';

    protected $labelField = '';

    protected $tableWhere = '';

    protected $lookupMode = self::MODE_CHILDREN;

    protected $lookupField = '';

    protected $rootUid = 0;

    protected $idCache = array();

    protected $columnConfiguration;

    protected $nodeSortValues = array();

    protected $generatedTSConfig = array();

    protected $signalSlotDispatcher;

    public function setLabelField($labelField) {
        $this->labelField = $labelField;
    }

    public function getLabelField() {
        return $this->labelField;
    }

    public function setTableName($tableName) {
        $this->tableName = $tableName;
    }

    public function getTableName() {
        return $this->tableName;
    }

    public function setLookupField($lookupField) {
        $this->lookupField = $lookupField;
    }

    public function getLookupField() {
        return $this->lookupField;
    }

    public function setLookupMode($lookupMode) {
        $this->lookupMode = $lookupMode;
    }

    public function getLookupMode() {
        return $this->lookupMode;
    }

    public function getNodes(\TYPO3\CMS\Backend\Tree\TreeNode $node) {

    }

    public function getRoot() {
        return $this->buildRepresentationForNode($this->treeData);
    }

    public function setRootUid($rootUid) {
        $this->rootUid = $rootUid;
    }

    public function getRootUid() {
        return $this->rootUid;
    }

    public function setTableWhere($tableWhere) {
        $this->tableWhere = $tableWhere;
    }

    public function getTableWhere() {
        return $this->tableWhere;
    }

    protected function buildRepresentationForNode(\TYPO3\CMS\Backend\Tree\TreeNode $basicNode, \TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeNode $parent = NULL, $level = 0) {
        $node = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Tree\\TableConfiguration\\DatabaseTreeNode');
        $row = array();
        if ($basicNode->getId() == 0) {
            $node->setSelected(FALSE);
            $node->setExpanded(TRUE);
            $node->setLabel($GLOBALS['LANG']->sL($GLOBALS['TCA'][$this->tableName]['ctrl']['title']));
        } else {
            $row = BackendUtility::getRecordWSOL($this->tableName, $basicNode->getId(), '*', '', FALSE);
            $node->setLabel(BackendUtility::getRecordTitle($this->tableName, $row) ?: $basicNode->getId());
            $node->setSelected(GeneralUtility::inList($this->getSelectedList(), $basicNode->getId()));
            $node->setExpanded($this->isExpanded($basicNode));
        }
        $node->setId($basicNode->getId());
        $node->setSelectable(!GeneralUtility::inList($this->getNonSelectableLevelList(), $level) && !in_array($basicNode->getId(), $this->getItemUnselectableList()));
        $node->setSortValue($this->nodeSortValues[$basicNode->getId()]);
        $node->setIcon(\TYPO3\CMS\Backend\Utility\IconUtility::mapRecordTypeToSpriteIconClass($this->tableName, $row));
        $node->setParentNode($parent);
        if ($basicNode->hasChildNodes()) {
            $node->setHasChildren(TRUE);
            $childNodes = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Tree\\SortedTreeNodeCollection');
            foreach ($basicNode->getChildNodes() as $child) {
                $childNodes->append($this->buildRepresentationForNode($child, $node, $level + 1));
            }
            $node->setChildNodes($childNodes);
        }
        return $node;
    }

    public function initializeTreeData() {
        parent::initializeTreeData();
        $this->nodeSortValues = array_flip($this->itemWhiteList);
        $this->columnConfiguration = $GLOBALS['TCA'][$this->getTableName()]['columns'][$this->getLookupField()]['config'];
        if (isset($this->columnConfiguration['foreign_table']) && $this->columnConfiguration['foreign_table'] != $this->getTableName()) {
            throw new \InvalidArgumentException('TCA Tree configuration is invalid: tree for different node-Tables is not implemented yet', 1290944650);
        }
        $this->treeData = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Tree\\TreeNode');
        $this->treeData->setId($this->getRootUid());
        $this->treeData->setParentNode(NULL);
        $childNodes = $this->getChildrenOf($this->treeData, 0);
        if ($childNodes !== NULL) {
            $this->treeData->setChildNodes($childNodes);
        }

        $this->emitPostProcessTreeDataSignal();
    }

    protected function getChildrenOf(\TYPO3\CMS\Backend\Tree\TreeNode $node, $level) {
        $nodeData = NULL;
        if ($node->getId() !== 0) {
            $nodeData = $GLOBALS['TYPO3_DB']->exec_SELECTgetSingleRow('*', $this->tableName, 'uid=' . $node->getId());
        }
        if ($nodeData == NULL) {
            $nodeData = array(
                'uid' => 0,
                $this->getLookupField() => ''
            );
        }
        $storage = NULL;
        $children = $this->getRelatedRecords($nodeData);
        if (count($children)) {
            $storage = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Tree\\TreeNodeCollection');
            foreach ($children as $child) {
                $node = GeneralUtility::makeInstance('TYPO3\\CMS\\Backend\\Tree\\TreeNode');
                $node->setId($child);
                if ($level <= $this->levelMaximum) {
                    $children = $this->getChildrenOf($node, $level + 1);
                    if ($children !== NULL) {
                        $node->setChildNodes($children);
                    }
                }
                $storage->append($node);
            }
        }
        return $storage;
    }

    protected function getRelatedRecords(array $row) {
        if ($this->getLookupMode() == DatabaseTreeDataProvider::MODE_PARENT) {
            $children = $this->getChildrenUidsFromParentRelation($row);
        } else {
            $children = $this->getChildrenUidsFromChildrenRelation($row);
        }
        $allowedArray = array();
        foreach ($children as $child) {
            if (!in_array($child, $this->idCache) && in_array($child, $this->itemWhiteList)) {
                $allowedArray[] = $child;
            }
        }
        $this->idCache = array_merge($this->idCache, $allowedArray);
        return $allowedArray;
    }

    protected function getChildrenUidsFromParentRelation(array $row) {
        $uid = $row['uid'];
        switch ((string) $this->columnConfiguration['type']) {
            case 'inline':

            case 'select':
                if ($this->columnConfiguration['MM']) {
                    $dbGroup = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Database\\RelationHandler');
                    // Dummy field for setting "look from other site"
                    $this->columnConfiguration['MM_oppositeField'] = 'children';
                    $dbGroup->start($row[$this->getLookupField()], $this->getTableName(), $this->columnConfiguration['MM'], $uid, $this->getTableName(), $this->columnConfiguration);
                    $relatedUids = $dbGroup->tableArray[$this->getTableName()];
                } elseif ($this->columnConfiguration['foreign_field']) {
                    $relatedUids = $this->listFieldQuery($this->columnConfiguration['foreign_field'], $uid);
                } else {
                    $relatedUids = $this->listFieldQuery($this->getLookupField(), $uid);
                }
                break;
            default:
                $relatedUids = $this->listFieldQuery($this->getLookupField(), $uid);
        }
        return $relatedUids;
    }

    protected function getChildrenUidsFromChildrenRelation(array $row) {
        $relatedUids = array();
        $uid = $row['uid'];
        $value = $row[$this->getLookupField()];
        switch ((string) $this->columnConfiguration['type']) {
            case 'inline':

            case 'select':
                if ($this->columnConfiguration['MM']) {
                    $dbGroup = GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Database\\RelationHandler');
                    $dbGroup->start($value, $this->getTableName(), $this->columnConfiguration['MM'], $uid, $this->getTableName(), $this->columnConfiguration);
                    $relatedUids = $dbGroup->tableArray[$this->getTableName()];
                } elseif ($this->columnConfiguration['foreign_field']) {
                    $records = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid', $this->getTableName(), $this->columnConfiguration['foreign_field'] . '=' . (int)$uid);
                    foreach ($records as $record) {
                        $relatedUids[] = $record['uid'];
                    }
                } else {
                    $relatedUids = GeneralUtility::intExplode(',', $value, TRUE);
                }
                break;
            default:
                $relatedUids = GeneralUtility::intExplode(',', $value, TRUE);
        }
        return $relatedUids;
    }

    protected function listFieldQuery($fieldName, $queryId) {
        $records = $GLOBALS['TYPO3_DB']->exec_SELECTgetRows('uid', $this->getTableName(), $GLOBALS['TYPO3_DB']->listQuery($fieldName, (int)$queryId, $this->getTableName()) . ((int)$queryId === 0 ? ' OR CAST(' . $fieldName . ' AS CHAR) = \'\'' : ''));
        $uidArray = array();
        foreach ($records as $record) {
            $uidArray[] = $record['uid'];
        }
        return $uidArray;
    }

    protected function emitPostProcessTreeDataSignal() {
        $this->getSignalSlotDispatcher()->dispatch('TYPO3\\CMS\\Core\\Tree\\TableConfiguration\\TableConfiguration\\DatabaseTreeDataProvider',
            self::SIGNAL_PostProcessTreeData,
            array($this, $this->treeData)
        );
    }

    protected function getSignalSlotDispatcher() {
        if (!isset($this->signalSlotDispatcher)) {
            $this->signalSlotDispatcher = $this->getObjectManager()->get('TYPO3\\CMS\\Extbase\\SignalSlot\\Dispatcher');
        }
        return $this->signalSlotDispatcher;
    }

    protected function getObjectManager() {
        return GeneralUtility::makeInstance('TYPO3\\CMS\\Extbase\\Object\\ObjectManager');
    }

}