PagetreeNode.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Backend\Tree\Pagetree;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

 use TYPO3\CMS\Core\Versioning\VersionState;

class PagetreeNode extends \TYPO3\CMS\Backend\Tree\ExtDirectNode
{
    protected $cachedAccessRights = [];

    protected $workspaceId = 0;

    protected $mountPoint = 0;

    protected $readableRootline = '';

    protected $isMountPoint = false;

    protected $stopPageTree = false;

    protected $backgroundColor = '';

    public function setBackgroundColor($backgroundColor)
    {
        $this->backgroundColor = $backgroundColor;
    }

    public function getBackgroundColor()
    {
        return $this->backgroundColor;
    }

    public function setWorkspaceId($workspaceId)
    {
        $this->workspaceId = (int)$workspaceId;
    }

    public function getWorkspaceId()
    {
        return $this->workspaceId;
    }

    public function setStopPageTree($stopPageTree)
    {
        $this->stopPageTree = (bool)$stopPageTree;
    }

    public function getStopPageTree()
    {
        return $this->stopPageTree;
    }

    public function setMountPoint($mountPoint)
    {
        $this->mountPoint = (int)$mountPoint;
    }

    public function getMountPoint()
    {
        return $this->mountPoint;
    }

    public function setIsMountPoint($isMountPoint)
    {
        $this->isMountPoint = $isMountPoint == true;
    }

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

    public function setReadableRootline($rootline)
    {
        $this->readableRootline = $rootline;
    }

    public function getReadableRootline()
    {
        return $this->readableRootline;
    }

    protected function canCreate()
    {
        if (!isset($this->cachedAccessRights['create'])) {
            $this->cachedAccessRights['create'] = $GLOBALS['BE_USER']->doesUserHaveAccess($this->record, 8);
        }
        return $this->cachedAccessRights['create'];
    }

    protected function canEdit()
    {
        if (!isset($this->cachedAccessRights['edit'])) {
            $this->cachedAccessRights['edit'] =
                $GLOBALS['BE_USER']->isAdmin()
                || (
                    (int)$this->record['editlock'] === 0
                    && $GLOBALS['BE_USER']->doesUserHaveAccess($this->record, 2)
                );
        }
        return $this->cachedAccessRights['edit'];
    }

    protected function canRemove()
    {
        if (!isset($this->cachedAccessRights['remove'])) {
            $this->cachedAccessRights['remove'] =
                $GLOBALS['BE_USER']->isAdmin()
                || (
                    (int)$this->record['editlock'] === 0
                    && $GLOBALS['BE_USER']->doesUserHaveAccess($this->record, 4)
                );
            if (!$this->isLeafNode() && !$GLOBALS['BE_USER']->uc['recursiveDelete']) {
                $this->cachedAccessRights['remove'] = false;
            }
        }
        return $this->cachedAccessRights['remove'];
    }

    public function canBeDisabledAndEnabled()
    {
        return $this->canEdit($this->record) && $GLOBALS['BE_USER']->checkLanguageAccess(0);
    }

    public function canBeCut()
    {
        return
            $this->canEdit($this->record)
            && !VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
            && $GLOBALS['BE_USER']->checkLanguageAccess(0)
        ;
    }

    public function canBeEdited()
    {
        return $this->canEdit($this->record) && $GLOBALS['BE_USER']->checkLanguageAccess(0);
    }

    public function canBeCopied()
    {
        return
            $GLOBALS['BE_USER']->doesUserHaveAccess($this->record, 1)
            && !VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
            && $GLOBALS['BE_USER']->checkLanguageAccess(0)
        ;
    }

    public function canCreateNewPages()
    {
        return $this->canCreate($this->record) && $GLOBALS['BE_USER']->checkLanguageAccess(0);
    }

    public function canBeRemoved()
    {
        return
            $this->canRemove($this->record)
            && !VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
            && $GLOBALS['BE_USER']->checkLanguageAccess(0)
        ;
    }

    public function canBePastedInto()
    {
        return
            $this->canCreate($this->record)
            && !VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
            && $GLOBALS['BE_USER']->checkLanguageAccess(0)
        ;
    }

    public function canBePastedAfter()
    {
        return
            $this->canCreate($this->record)
            && !VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
            && $GLOBALS['BE_USER']->checkLanguageAccess(0)
        ;
    }

    public function canShowHistory()
    {
        return $GLOBALS['BE_USER']->checkLanguageAccess(0);
    }

    public function canBeViewed()
    {
        return !$this->isDeleted();
    }

    public function canShowInfo()
    {
        return true;
    }

    public function canBeTemporaryMountPoint()
    {
        return true;
    }

    public function isDeleted()
    {
        return
            !empty($this->record['deleted'])
            || VersionState::cast($this->record['t3ver_state'])->equals(VersionState::DELETE_PLACEHOLDER)
        ;
    }

    public function calculateNodeId($prefix = 'p')
    {
        return $prefix . dechex($this->getId()) . ($this->getMountPoint() ? '-' . dechex($this->getMountPoint()) : '');
    }

    public function toArray($addChildNodes = true)
    {
        $arrayRepresentation = parent::toArray();
        $arrayRepresentation['id'] = $this->calculateNodeId();
        $arrayRepresentation['realId'] = $this->getId();
        $arrayRepresentation['nodeData']['id'] = $this->getId();
        $arrayRepresentation['readableRootline'] = $this->getReadableRootline();
        $arrayRepresentation['canBeRemoved'] = $this->canBeRemoved();
        $arrayRepresentation['nodeData']['readableRootline'] = $this->getReadableRootline();
        $arrayRepresentation['nodeData']['mountPoint'] = $this->getMountPoint();
        $arrayRepresentation['nodeData']['workspaceId'] = $this->getWorkspaceId();
        $arrayRepresentation['nodeData']['isMountPoint'] = $this->isMountPoint();
        $arrayRepresentation['nodeData']['backgroundColor'] = htmlspecialchars($this->getBackgroundColor());
        $arrayRepresentation['nodeData']['stopPageTree'] = $this->getStopPageTree();
        $arrayRepresentation['nodeData']['serializeClassName'] = get_class($this);
        return $arrayRepresentation;
    }

    public function dataFromArray($data)
    {
        parent::dataFromArray($data);
        $this->setWorkspaceId($data['workspaceId']);
        $this->setMountPoint($data['mountPoint']);
        $this->setReadableRootline($data['readableRootline']);
        $this->setIsMountPoint($data['isMountPoint']);
        $this->setBackgroundColor($data['backgroundColor']);
    }
}