Added feature #16033: API for Trees and ContextMenus (Thanks to Stefan Galinski)
[Packages/TYPO3.CMS.git] / t3lib / contextmenu / class.t3lib_contextmenu_abstractcontextmenu.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010 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 Context Menu
30 *
31 * @author Stefan Galinski <stefan.galinski@gmail.com>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 abstract class t3lib_contextmenu_AbstractContextMenu {
36 /**
37 * Data Provider
38 *
39 * @var t3lib_contextmenu_AbstractDataProvider
40 */
41 protected $dataProvider = NULL;
42
43 /**
44 * @param t3lib_tree_AbstractDataProvider $dataProvider
45 * @return void
46 */
47 public function setDataProvider(t3lib_tree_AbstractDataProvider $dataProvider) {
48 $this->dataProvider = $dataProvider;
49 }
50
51 /**
52 * @return t3lib_tree_AbstractDataProvider
53 */
54 public function getDataProvider() {
55 return $this->dataProvider;
56 }
57
58 /**
59 * Returns the actions for the given node informations
60 *
61 * @param t3lib_tree_Node $node
62 * @return array
63 */
64 abstract public function getActionsForNode(t3lib_tree_Node $node);
65 }