Fixed bug #11621: XSS vulnerabilities in workspace module
[Packages/TYPO3.CMS.git] / typo3 / interfaces / interface.backend_toolbaritem.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2007-2009 Ingo Renner <ingo@typo3.org>
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 /**
30 * interface for classes which extend the backend by adding items to the top toolbar
31 *
32 * @author Ingo Renner <ingo@typo3.org>
33 * @package TYPO3
34 * @subpackage t3lib
35 */
36 interface backend_toolbarItem {
37
38 /**
39 * constructor that receives a back reference to the backend
40 *
41 * @param TYPO3backend TYPO3 backend object reference
42 */
43 public function __construct(TYPO3backend &$backendReference = null);
44
45 /**
46 * checks whether the user has access to this toolbar item
47 *
48 * @return boolean true if user has access, false if not
49 */
50 public function checkAccess();
51
52 /**
53 * renders the toolbar item
54 *
55 * @return string the toolbar item rendered as HTML string
56 */
57 public function render();
58
59 /**
60 * returns additional attributes for the list item in the toolbar
61 *
62 * @return string list item HTML attibutes
63 */
64 public function getAdditionalAttributes();
65 }
66
67 ?>