class.t3lib_tree_renderer_extjsjson.php

Go to the documentation of this file.

<?php
/***************************************************************
 *  Copyright notice
 *
 *  (c) 2010-2011 Steffen Kamper <steffen@typo3.org>
 *  (c) 2010-2011 Steffen Ritter <info@steffen-ritter.net>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/


/**
 * Renderer for unordered lists
 *
 * @author Steffen Kamper <steffen@typo3.org>
 * @author Steffen Ritter <info@steffen-ritter.net>
 * @package TYPO3
 * @subpackage t3lib
 */
class t3lib_tree_Renderer_ExtJsJson extends t3lib_tree_Renderer_Abstract {
    /**
     * recursion level
     *
     * @var int
     */
    protected $recursionLevel = 0;

    /**
     * Renders a node recursive or just a single instance
     *
     * @param t3lib_tree_RepresentationNode $node
     * @param bool $recursive
     * @return mixed
     */
    public function renderNode(t3lib_tree_RepresentationNode $node, $recursive = TRUE) {
        $nodeArray = $this->getNodeArray($node);

        if ($recursive && $node->hasChildNodes()) {
            $this->recursionLevel++;
            $children = $this->renderNodeCollection($node->getChildNodes());
            $nodeArray['children'] = $children;
            $this->recursionLevel--;
        }

        return $nodeArray;
    }

    /**
     *
     */
    protected function getNodeArray(t3lib_tree_RepresentationNode $node) {
        $nodeArray = array(
            'iconCls' => $node->getIcon(),
            'text' => $node->getLabel(),
            'leaf' => !$node->hasChildNodes(),
            'id' => $node->getId(),
            'uid' => $node->getId()
        );

        return $nodeArray;
    }

    /**
     * Renders a node collection recursive or just a single instance
     *
     * @param t3lib_tree_NodeCollection $node
     * @param bool $recursive
     * @return mixed
     */
    public function renderTree(t3lib_tree_AbstractTree $tree, $recursive = TRUE) {
        $this->recursionLevel = 0;
        $children = $this->renderNode($tree->getRoot(), $recursive);

        return json_encode($children);
    }

    /**
     * Renders an tree recursive or just a single instance
     *
     * @param t3lib_tree_AbstractTree $node
     * @param bool $recursive
     * @return mixed
     */
    public function renderNodeCollection(t3lib_tree_NodeCollection $collection, $recursive = TRUE) {
        foreach ($collection as $node) {
            $treeItems[] = $this->renderNode($node, $recursive);
        }
        return $treeItems;
    }
}

?>