ExtDirectNode.php

Go to the documentation of this file.

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

class ExtDirectNode extends \TYPO3\CMS\Backend\Tree\TreeNode {

    protected $type = '';

    protected $leaf = TRUE;

    protected $expanded = FALSE;

    protected $expandable = FALSE;

    protected $draggable = TRUE;

    protected $isDropTarget = TRUE;

    protected $text = '';

    protected $editableText = '';

    protected $prefix = '';

    protected $suffix = '';

    protected $cls = '';

    protected $qtip = '';

    protected $spriteIconCode = '';

    protected $t3TextSourceField = '';

    protected $t3InCopyMode = FALSE;

    protected $t3InCutMode = FALSE;

    protected $record = array();

    protected $contextInfo = array();

    protected $labelIsEditable = TRUE;

    protected $allowChildren = TRUE;

    public function setType($type) {
        $this->type = $type;
    }

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

    public function setLeaf($isLeaf) {
        $this->leaf = $isLeaf == TRUE;
    }

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

    public function setExpandable($expandable) {
        $this->expandable = $expandable == TRUE;
    }

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

    public function setExpanded($expanded) {
        $this->expanded = $expanded == TRUE;
    }

    public function isExpanded() {
        if ($this->isLeafNode()) {
            return TRUE;
        }
        return $this->expanded;
    }

    public function setDraggable($draggable) {
        $this->draggable = $draggable == TRUE;
    }

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

    public function setIsDropTarget($isDropTarget) {
        $this->isDropTarget = $isDropTarget == TRUE;
    }

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

    public function setText($text, $textSourceField = 'title', $prefix = '', $suffix = '') {
        $this->text = $text;
        $this->t3TextSourceField = $textSourceField;
        $this->prefix = $prefix;
        $this->suffix = $suffix;
    }

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

    public function setEditableText($editableText) {
        $this->editableText = $editableText;
    }

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

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

    public function setInCopyMode($inCopyMode) {
        $this->t3InCopyMode = $inCopyMode == TRUE;
    }

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

    public function setInCutMode($inCutMode) {
        $this->t3InCutMode = $inCutMode == TRUE;
    }

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

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

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

    public function setCls($class) {
        $this->cls = $class;
    }

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

    public function setQTip($qtip) {
        $this->qtip = $qtip;
    }

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

    public function setSpriteIconCode($spriteIcon) {
        $this->spriteIconCode = $spriteIcon;
    }

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

    public function setLabelIsEditable($labelIsEditable) {
        $this->labelIsEditable = $labelIsEditable == TRUE;
    }

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

    public function setRecord($record) {
        $this->record = (array) $record;
    }

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

    public function setContextInfo($contextInfo) {
        $this->contextInfo = (array) $contextInfo;
    }

    public function getContextInfo() {
        return (array) $this->contextInfo;
    }

    public function setChildNodes(\TYPO3\CMS\Backend\Tree\TreeNodeCollection $childNodes) {
        parent::setChildNodes($childNodes);
        if ($childNodes->count()) {
            $this->setLeaf(FALSE);
        }
    }

    public function setAllowChildren($allowChildren) {
        $this->allowChildren = $allowChildren == TRUE;
    }

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

    public function toArray($addChildNodes = TRUE) {
        $arrayRepresentation = array(
            'serializeClassName' => get_class($this),
            'id' => $this->getId(),
            'type' => $this->getType(),
            'editableText' => $this->getEditableText(),
            'text' => $this->getPrefix() . $this->getText() . $this->getSuffix(),
            'cls' => $this->getCls(),
            'prefix' => $this->getPrefix(),
            'suffix' => $this->getSuffix(),
            'qtip' => $this->getQTip(),
            'expanded' => $this->isExpanded(),
            'expandable' => $this->isExpandable(),
            'draggable' => $this->isDraggable(),
            'isTarget' => $this->isDropTarget(),
            'spriteIconCode' => $this->getSpriteIconCode(),
            't3TextSourceField' => $this->getTextSourceField(),
            't3InCopyMode' => $this->isInCopyMode(),
            't3InCutMode' => $this->isInCutMode(),
            't3ContextInfo' => $this->getContextInfo(),
            'editable' => $this->isLabelEditable(),
            'allowChildren' => $this->canHaveChildren()
        );
        // only set the leaf attribute if the node has children's,
        // otherwise you cannot add child's to real leaf nodes
        if (!$this->isLeafNode()) {
            $arrayRepresentation['leaf'] = FALSE;
        }
        // Suhosin(?) or some other strange environment thingy prevents
        // the direct copy of an array into an index of the same array
        $copy = $arrayRepresentation;
        $arrayRepresentation['nodeData'] = $copy;
        if ($this->hasChildNodes()) {
            $arrayRepresentation['children'] = $this->childNodes->toArray();
        }
        return $arrayRepresentation;
    }

    public function dataFromArray($data) {
        parent::dataFromArray($data);
        $this->setType($data['type']);
        $this->setText($data['label'], $data['t3TextSourceField'], $data['prefix'], $data['suffix']);
        $this->setEditableText($data['editableText']);
        $this->setCls($data['cls']);
        $this->setQTip($data['qtip']);
        $this->setExpanded($data['expanded']);
        $this->setExpandable($data['expandable']);
        $this->setDraggable($data['draggable']);
        $this->setIsDropTarget($data['isTarget']);
        $this->setSpriteIconCode($data['spriteIconCode']);
        $this->setInCopyMode($data['t3InCopyMode']);
        $this->setInCutMode($data['t3InCutMode']);
        $this->setContextInfo($data['t3ContextInfo']);
        $this->setLabelIsEditable($data['editable']);
        $this->setAllowChildren($data['allowChildren']);
        // only set the leaf attribute if it's applied
        // otherwise you cannot insert nodes into this one
        if (isset($data['leaf'])) {
            $this->setLeaf(FALSE);
        }
    }

}