8e996618605b53e55eb46725cca5b7fe379167e6
[Packages/TYPO3.CMS.git] / t3lib / tree / class.t3lib_tree_abstractdataprovider.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 TYPO3 Tree Team <http://forge.typo3.org/projects/typo3v4-extjstrees>
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 * Abstract Tree Data Provider
30 *
31 * @author Stefan Galinski <stefan.galinski@gmail.com>
32 * @author Steffen Ritter <info@steffen-ritter.net>
33 * @package TYPO3
34 * @subpackage t3lib
35 */
36 abstract class t3lib_tree_AbstractDataProvider {
37 /**
38 * Root Node
39 *
40 * @var t3lib_tree_Node
41 */
42 protected $rootNode = NULL;
43
44 /**
45 * Returns the root node
46 *
47 * @abstract
48 * @return t3lib_tree_Node
49 */
50 abstract public function getRoot();
51
52 /**
53 * Fetches the subnodes of the given node
54 *
55 * @abstract
56 * @param t3lib_tree_Node $node
57 * @return t3lib_tree_NodeCollection
58 */
59 abstract public function getNodes(t3lib_tree_Node $node);
60 }
61
62 ?>