PageTreeView.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\View;

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

class PageTreeView extends \TYPO3\CMS\Backend\Tree\View\BrowseTreeView {

    public $ext_showPageId;

    public $ext_IconMode;

    public $ext_separateNotinmenuPages;

    public $ext_alphasortNotinmenuPages;

    // Indicates, whether the ajax call was successful, i.e. the requested page has been found
    public $ajaxStatus = FALSE;

    public function __construct() {
        $this->init();
    }

    public function wrapIcon($thePageIcon, &$row) {
        // If the record is locked, present a warning sign.
        if ($lockInfo = \TYPO3\CMS\Backend\Utility\BackendUtility::isRecordLocked('pages', $row['uid'])) {
            $aOnClick = 'alert(' . GeneralUtility::quoteJSvalue($lockInfo['msg']) . ');return false;';
            $lockIcon = '<a href="#" onclick="' . htmlspecialchars($aOnClick) . '">' . IconUtility::getSpriteIcon('status-warning-in-use', array('title' => $lockInfo['msg'])) . '</a>';
        } else {
            $lockIcon = '';
        }
        // Wrap icon in click-menu link.
        if (!$this->ext_IconMode) {
            $thePageIcon = $GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon($thePageIcon, 'pages', $row['uid'], 0, '&bank=' . $this->bank);
        } elseif ($this->ext_IconMode === 'titlelink') {
            $aOnClick = 'return jumpTo(\'' . $this->getJumpToParam($row) . '\',this,\'' . $this->treeName . '\');';
            $thePageIcon = '<a href="#" onclick="' . htmlspecialchars($aOnClick) . '">' . $thePageIcon . '</a>';
        }
        // Wrap icon in a drag/drop span.
        $dragDropIcon = '<span class="dragIcon" id="dragIconID_' . $row['uid'] . '">' . $thePageIcon . '</span>';
        // Add Page ID:
        $pageIdStr = '';
        if ($this->ext_showPageId) {
            $pageIdStr = '<span class="dragId">[' . $row['uid'] . ']</span> ';
        }
        // Call stats information hook
        $stat = '';
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'])) {
            $_params = array('pages', $row['uid']);
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['GLOBAL']['recStatInfoHooks'] as $_funcRef) {
                $stat .= GeneralUtility::callUserFunction($_funcRef, $_params, $this);
            }
        }
        return $dragDropIcon . $lockIcon . $pageIdStr . $stat;
    }

    public function wrapStop($str, $row) {
        if ($row['php_tree_stop']) {
            $str .= '<a href="' . htmlspecialchars(GeneralUtility::linkThisScript(array('setTempDBmount' => $row['uid']))) . '" class="typo3-red">+</a> ';
        }
        return $str;
    }

    public function wrapTitle($title, $row, $bank = 0) {
        // Hook for overriding the page title
        if (is_array($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'])) {
            $_params = array('title' => &$title, 'row' => &$row);
            foreach ($GLOBALS['TYPO3_CONF_VARS']['SC_OPTIONS']['typo3/class.webpagetree.php']['pageTitleOverlay'] as $_funcRef) {
                GeneralUtility::callUserFunction($_funcRef, $_params, $this);
            }
            unset($_params);
        }
        $aOnClick = 'return jumpTo(\'' . $this->getJumpToParam($row) . '\',this,\'' . $this->domIdPrefix . $this->getId($row) . '\',' . $bank . ');';
        $CSM = ' oncontextmenu="' . htmlspecialchars($GLOBALS['TBE_TEMPLATE']->wrapClickMenuOnIcon('', 'pages', $row['uid'], 0, ('&bank=' . $this->bank), '', TRUE)) . ';"';
        $thePageTitle = '<a href="#" onclick="' . htmlspecialchars($aOnClick) . '"' . $CSM . '>' . $title . '</a>';
        // Wrap title in a drag/drop span.
        return '<span class="dragTitle" id="dragTitleID_' . $row['uid'] . '">' . $thePageTitle . '</span>';
    }

    public function printTree($treeArr = '') {
        $titleLen = (int)$this->BE_USER->uc['titleLen'];
        if (!is_array($treeArr)) {
            $treeArr = $this->tree;
        }
        $out = '
            <!-- TYPO3 tree structure. -->
            <ul class="tree" id="treeRoot">
        ';
        // -- evaluate AJAX request
        // IE takes anchor as parameter
        $PM = GeneralUtility::_GP('PM');
        if (($PMpos = strpos($PM, '#')) !== FALSE) {
            $PM = substr($PM, 0, $PMpos);
        }
        $PM = explode('_', $PM);
        if (TYPO3_REQUESTTYPE & TYPO3_REQUESTTYPE_AJAX && is_array($PM) && count($PM) == 4 && $PM[2] != 0) {
            if ($PM[1]) {
                $expandedPageUid = $PM[2];
                $ajaxOutput = '';
                // We don't know yet. Will be set later.
                $invertedDepthOfAjaxRequestedItem = 0;
                $doExpand = TRUE;
            } else {
                $collapsedPageUid = $PM[2];
                $doCollapse = TRUE;
            }
        }
        // We need to count the opened <ul>'s every time we dig into another level,
        // so we know how many we have to close when all children are done rendering
        $closeDepth = array();
        foreach ($treeArr as $k => $v) {
            $classAttr = $v['row']['_CSSCLASS'];
            $uid = $v['row']['uid'];
            $idAttr = htmlspecialchars($this->domIdPrefix . $this->getId($v['row']) . '_' . $v['bank']);
            $itemHTML = '';
            // If this item is the start of a new level,
            // then a new level <ul> is needed, but not in ajax mode
            if ($v['isFirst'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) {
                $itemHTML = '<ul>';
            }
            // Add CSS classes to the list item
            if ($v['hasSub']) {
                $classAttr .= $classAttr ? ' expanded' : 'expanded';
            }
            if ($v['isLast']) {
                $classAttr .= $classAttr ? ' last' : 'last';
            }
            $itemHTML .= '
                <li id="' . $idAttr . '"' . ($classAttr ? ' class="' . $classAttr . '"' : '') . '><div class="treeLinkItem">' . $v['HTML'] . $this->wrapTitle($this->getTitleStr($v['row'], $titleLen), $v['row'], $v['bank']) . '</div>
';
            if (!$v['hasSub']) {
                $itemHTML .= '</li>';
            }
            // We have to remember if this is the last one
            // on level X so the last child on level X+1 closes the <ul>-tag
            if ($v['isLast'] && !($doExpand && $expandedPageUid == $uid)) {
                $closeDepth[$v['invertedDepth']] = 1;
            }
            // If this is the last one and does not have subitems, we need to close
            // the tree as long as the upper levels have last items too
            if ($v['isLast'] && !$v['hasSub'] && !$doCollapse && !($doExpand && $expandedPageUid == $uid)) {
                for ($i = $v['invertedDepth']; $closeDepth[$i] == 1; $i++) {
                    $closeDepth[$i] = 0;
                    $itemHTML .= '</ul></li>';
                }
            }
            // Ajax request: collapse
            if ($doCollapse && $collapsedPageUid == $uid) {
                $this->ajaxStatus = TRUE;
                return $itemHTML;
            }
            // ajax request: expand
            if ($doExpand && $expandedPageUid == $uid) {
                $ajaxOutput .= $itemHTML;
                $invertedDepthOfAjaxRequestedItem = $v['invertedDepth'];
            } elseif ($invertedDepthOfAjaxRequestedItem) {
                if ($v['invertedDepth'] < $invertedDepthOfAjaxRequestedItem) {
                    $ajaxOutput .= $itemHTML;
                } else {
                    $this->ajaxStatus = TRUE;
                    return $ajaxOutput;
                }
            }
            $out .= $itemHTML;
        }
        if ($ajaxOutput) {
            $this->ajaxStatus = TRUE;
            return $ajaxOutput;
        }
        // Finally close the first ul
        $out .= '</ul>';
        return $out;
    }

    public function PMicon($row, $a, $c, $nextCount, $exp) {
        $PM = $nextCount ? ($exp ? 'minus' : 'plus') : 'join';
        $BTM = $a == $c ? 'bottom' : '';
        $icon = '<img' . IconUtility::skinImg($this->backPath, ('gfx/ol/' . $PM . $BTM . '.gif'), 'width="18" height="16"') . ' alt="" />';
        if ($nextCount) {
            $cmd = $this->bank . '_' . ($exp ? '0_' : '1_') . $row['uid'] . '_' . $this->treeName;
            $icon = $this->PMiconATagWrap($icon, $cmd, !$exp);
        }
        return $icon;
    }

    public function PMiconATagWrap($icon, $cmd, $isExpand = TRUE) {
        if ($this->thisScript) {
            // Activate dynamic ajax-based tree
            $js = htmlspecialchars('Tree.load(\'' . $cmd . '\', ' . (int)$isExpand . ', this);');
            return '<a class="pm" onclick="' . $js . '">' . $icon . '</a>';
        } else {
            return $icon;
        }
    }

    public function getBrowsableTree() {
        // Get stored tree structure AND updating it if needed according to incoming PM GET var.
        $this->initializePositionSaving();
        // Init done:
        $titleLen = (int)$this->BE_USER->uc['titleLen'];
        $treeArr = array();
        // Traverse mounts:
        foreach ($this->MOUNTS as $idx => $uid) {
            // Set first:
            $this->bank = $idx;
            $isOpen = $this->stored[$idx][$uid] || $this->expandFirst || $uid === '0';
            // Save ids while resetting everything else.
            $curIds = $this->ids;
            $this->reset();
            $this->ids = $curIds;
            // Set PM icon for root of mount:
            $cmd = $this->bank . '_' . ($isOpen ? '0_' : '1_') . $uid . '_' . $this->treeName;
            // Only, if not for uid 0
            if ($uid) {
                $icon = '<img' . IconUtility::skinImg($this->backPath, ('gfx/ol/' . ($isOpen ? 'minus' : 'plus') . 'only.gif')) . ' alt="" />';
                $firstHtml = $this->PMiconATagWrap($icon, $cmd, !$isOpen);
            }
            // Preparing rootRec for the mount
            if ($uid) {
                $rootRec = $this->getRecord($uid);
                $firstHtml .= $this->getIcon($rootRec);
            } else {
                // Artificial record for the tree root, id=0
                $rootRec = $this->getRootRecord($uid);
                $firstHtml .= $this->getRootIcon($rootRec);
            }
            if (is_array($rootRec)) {
                // In case it was swapped inside getRecord due to workspaces.
                $uid = $rootRec['uid'];
                // Add the root of the mount to ->tree
                $this->tree[] = array('HTML' => $firstHtml, 'row' => $rootRec, 'bank' => $this->bank, 'hasSub' => TRUE, 'invertedDepth' => 1000);
                // If the mount is expanded, go down:
                if ($isOpen) {
                    // Set depth:
                    if ($this->addSelfId) {
                        $this->ids[] = $uid;
                    }
                    $this->getTree($uid, 999, '', $rootRec['_SUBCSSCLASS']);
                }
                // Add tree:
                $treeArr = array_merge($treeArr, $this->tree);
            }
        }
        return $this->printTree($treeArr);
    }

    public function getTree($uid, $depth = 999, $blankLineCode = '', $subCSSclass = '') {
        // Buffer for id hierarchy is reset:
        $this->buffer_idH = array();
        // Init vars
        $depth = (int)$depth;
        $HTML = '';
        $a = 0;
        $res = $this->getDataInit($uid, $subCSSclass);
        $c = $this->getDataCount($res);
        $crazyRecursionLimiter = 999;
        $inMenuPages = array();
        $outOfMenuPages = array();
        $outOfMenuPagesTextIndex = array();
        while ($crazyRecursionLimiter > 0 && ($row = $this->getDataNext($res, $subCSSclass))) {
            $crazyRecursionLimiter--;
            // Not in menu:
            if ($this->ext_separateNotinmenuPages && ($row['doktype'] == \TYPO3\CMS\Frontend\Page\PageRepository::DOKTYPE_BE_USER_SECTION || $row['doktype'] >= 200 || $row['nav_hide'])) {
                $outOfMenuPages[] = $row;
                $outOfMenuPagesTextIndex[] = ($row['doktype'] >= 200 ? 'zzz' . $row['doktype'] . '_' : '') . $row['title'];
            } else {
                $inMenuPages[] = $row;
            }
        }
        $label_shownAlphabetically = '';
        if (count($outOfMenuPages)) {
            // Sort out-of-menu pages:
            $outOfMenuPages_alphabetic = array();
            if ($this->ext_alphasortNotinmenuPages) {
                asort($outOfMenuPagesTextIndex);
                $label_shownAlphabetically = ' (alphabetic)';
            }
            foreach ($outOfMenuPagesTextIndex as $idx => $txt) {
                $outOfMenuPages_alphabetic[] = $outOfMenuPages[$idx];
            }
            // Merge:
            $outOfMenuPages_alphabetic[0]['_FIRST_NOT_IN_MENU'] = TRUE;
            $allRows = array_merge($inMenuPages, $outOfMenuPages_alphabetic);
        } else {
            $allRows = $inMenuPages;
        }
        // Traverse the records:
        foreach ($allRows as $row) {
            $a++;
            $newID = $row['uid'];
            // Reserve space.
            $this->tree[] = array();
            end($this->tree);
            // Get the key for this space
            $treeKey = key($this->tree);
            $LN = $a == $c ? 'blank' : 'line';
            // If records should be accumulated, do so
            if ($this->setRecs) {
                $this->recs[$row['uid']] = $row;
            }
            // Accumulate the id of the element in the internal arrays
            $this->ids[] = ($idH[$row['uid']]['uid'] = $row['uid']);
            $this->ids_hierarchy[$depth][] = $row['uid'];
            // Make a recursive call to the next level
            if ($depth > 1 && $this->expandNext($newID) && !$row['php_tree_stop']) {
                $nextCount = $this->getTree($newID, $depth - 1, $blankLineCode . ',' . $LN, $row['_SUBCSSCLASS']);
                if (count($this->buffer_idH)) {
                    $idH[$row['uid']]['subrow'] = $this->buffer_idH;
                }
                // Set "did expand" flag
                $exp = 1;
            } else {
                $nextCount = $this->getCount($newID);
                // Clear "did expand" flag
                $exp = 0;
            }
            // Set HTML-icons, if any:
            if ($this->makeHTML) {
                if ($row['_FIRST_NOT_IN_MENU']) {
                    $HTML = '<img' . IconUtility::skinImg($this->backPath, 'gfx/ol/line.gif') . ' alt="" /><br/><img' . IconUtility::skinImg($this->backPath, 'gfx/ol/line.gif') . ' alt="" /><i>Not shown in menu' . $label_shownAlphabetically . ':</i><br>';
                } else {
                    $HTML = '';
                }
                $HTML .= $this->PMicon($row, $a, $c, $nextCount, $exp);
                $HTML .= $this->wrapStop($this->getIcon($row), $row);
            }
            // Finally, add the row/HTML content to the ->tree array in the reserved key.
            $this->tree[$treeKey] = array(
                'row' => $row,
                'HTML' => $HTML,
                'hasSub' => $nextCount && $this->expandNext($newID),
                'isFirst' => $a == 1,
                'isLast' => FALSE,
                'invertedDepth' => $depth,
                'blankLineCode' => $blankLineCode,
                'bank' => $this->bank
            );
        }
        if ($a) {
            $this->tree[$treeKey]['isLast'] = TRUE;
        }
        $this->getDataFree($res);
        $this->buffer_idH = $idH;
        return $c;
    }

}