Cleanup: Updated copyright comments
[Packages/TYPO3.CMS.git] / typo3 / sysext / cms / tslib / interfaces / interface.tslib_menu_filterMenuPagesHook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2010-2011 Tolleiv Nietsch <nietsch@aoemedia.de>
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 hook into tslib_menu
31 *
32 * @author Tolleiv Nietsch <nietsch@aoemedia.de>
33 * @package TYPO3
34 */
35
36 interface tslib_menu_filterMenuPagesHook {
37
38 /**
39 * Checks if a page is OK to include in the final menu item array.
40 *
41 * @param array Array of menu items
42 * @param array Array of page uids which are to be excluded
43 * @param boolean If set, then the page is a spacer.
44 * @param tslib_tmenu The menu object
45 * @return boolean Returns true if the page can be safely included.
46 */
47 public function tslib_menu_filterMenuPagesHook (array &$data, array $banUidArray, $spacer, tslib_tmenu $obj);
48 }
49
50 ?>