TreeNode.php

Go to the documentation of this file.

<?php
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Backend\Tree;
 
use ‪TYPO3\CMS\Core\Exception;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
 
class ‪TreeNode implements ‪ComparableNodeInterface
{
    protected ‪$id = '';
 
    protected ‪$parentNode;
 
    protected ‪$childNodes;
 
    protected array ‪$additionalData = [];
 
    public function ‪__construct(array $data = [])
    {
        if ($data !== []) {
            $this->‪dataFromArray($data);
        }
    }
 
    public function ‪setChildNodes(‪TreeNodeCollection ‪$childNodes)
    {
        $this->childNodes = ‪$childNodes;
    }
 
    public function ‪removeChildNodes()
    {
        if ($this->childNodes !== null) {
            unset($this->childNodes);
            $this->childNodes = null;
        }
    }
 
    public function ‪getChildNodes()
    {
        return ‪$this->childNodes;
    }
 
    public function ‪hasChildNodes()
    {
        if ($this->childNodes !== null) {
            return true;
        }
        return false;
    }
 
    public function ‪setId(‪$id)
    {
        $this->id = ‪$id;
    }
 
    public function ‪getId()
    {
        return ‪$this->id;
    }
 
    public function ‪setParentNode(‪TreeNode ‪$parentNode = null)
    {
        $this->parentNode = ‪$parentNode;
    }
 
    public function ‪getParentNode()
    {
        return ‪$this->parentNode;
    }
 
    public function ‪equals(‪TreeNode $other)
    {
        return $this->id == $other->‪getId();
    }
 
    public function ‪compareTo($other)
    {
        if ($this->‪equals($other)) {
            return 0;
        }
        return $this->id > $other->‪getId() ? 1 : -1;
    }
 
    public function ‪getAdditionalData(): array
    {
        return ‪$this->additionalData;
    }
 
    public function ‪toArray($addChildNodes = true)
    {
        $arrayRepresentation = [
            'serializeClassName' => static::class,
            'id' => ‪$this->id,
        ];
        if ($this->parentNode !== null) {
            $arrayRepresentation['parentNode'] = $this->parentNode->toArray(false);
        } else {
            $arrayRepresentation['parentNode'] = '';
        }
        if ($this->‪hasChildNodes() && $addChildNodes) {
            $arrayRepresentation['childNodes'] = $this->childNodes->toArray();
        } else {
            $arrayRepresentation['childNodes'] = '';
        }
        return $arrayRepresentation;
    }
 
    public function ‪dataFromArray($data)
    {
        $this->‪setId($data['id'] ?? $data['uid']);
        if (isset($data['parentNode']) && $data['parentNode'] !== '') {
            ‪$parentNode = GeneralUtility::makeInstance($data['parentNode']['serializeClassName'], $data['parentNode']);
            $this->‪setParentNode(‪$parentNode);
        }
        if (isset($data['childNodes']) && $data['childNodes'] !== '') {
            ‪$childNodes = GeneralUtility::makeInstance($data['childNodes']['serializeClassName'], $data['childNodes']);
            $this->‪setChildNodes($childNodes);
        }
        // @todo: This is part of the category tree performance hack
        $this->additionalData = $data;
    }
 
    public function ‪__serialize(): array
    {
        return $this->‪toArray();
    }
 
    public function ‪__unserialize(array $arrayRepresentation): void
    {
        if ($arrayRepresentation['serializeClassName'] !== static::class) {
            throw new ‪Exception('Deserialized object type is not identical!', 1294586646);
        }
        $this->‪dataFromArray($arrayRepresentation);
    }
}