[TASK] Clean up the phpDoc of t3lib/tree/
[Packages/TYPO3.CMS.git] / t3lib / tree / tca / class.t3lib_tree_tca_extjsarrayrenderer.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 Steffen Ritter <info@steffen-ritter.net>
6 * All rights reserved
7 *
8 * This script is part of the TYPO3 project. The TYPO3 project is
9 * free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * The GNU General Public License can be found at
15 * http://www.gnu.org/copyleft/gpl.html.
16 * A copy is found in the textfile GPL.txt and important notices to the license
17 * from the author is found in LICENSE.txt distributed with these scripts.
18 *
19 *
20 * This script is distributed in the hope that it will be useful,
21 * but WITHOUT ANY WARRANTY; without even the implied warranty of
22 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 * GNU General Public License for more details.
24 *
25 * This copyright notice MUST APPEAR in all copies of the script!
26 ***************************************************************/
27
28 /**
29 * Renders a tca tree array for ExtJS
30 *
31 * @author Steffen Ritter <info@steffen-ritter.net>
32 * @package TYPO3
33 * @subpackage t3lib_tree
34 */
35 class t3lib_tree_Tca_ExtJsArrayRenderer extends t3lib_tree_Renderer_ExtJsJson {
36
37 /**
38 * Gets the node array. If the TCA configuration has defined items,
39 * they are added to rootlevel on top of the tree
40 *
41 * @param t3lib_tree_Tca_DatabaseNode $node
42 * @return array
43 */
44 protected function getNodeArray(t3lib_tree_Tca_DatabaseNode $node) {
45 $nodeArray = parent::getNodeArray($node);
46 $nodeArray = array_merge(
47 $nodeArray,
48 array(
49 'expanded' => $node->getExpanded(),
50 'expandable' => $node->hasChildNodes(),
51 'checked' => $node->getSelected(),
52 )
53 );
54 if (!$node->getSelectable()) {
55 unset ($nodeArray['checked']);
56 }
57
58 return $nodeArray;
59 }
60
61 /**
62 * Renders a node collection recursive or just a single instance
63 *
64 * @param t3lib_tree_NodeCollection $node
65 * @param boolean $recursive
66 * @return array
67 */
68 public function renderTree(t3lib_tree_AbstractTree $tree, $recursive = TRUE) {
69 $this->recursionLevel = 0;
70 $children = $this->renderNode($tree->getRoot(), $recursive);
71
72 return $children;
73 }
74 }
75
76 ?>