[TASK] Clean up the phpDoc of t3lib/interfaces/
[Packages/TYPO3.CMS.git] / t3lib / interfaces / interface.t3lib_browselinkshook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2007-2011 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 * Interface for classes which hook into browse_links
30 *
31 * @author Ingo Renner <ingo@typo3.org>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 interface t3lib_browseLinksHook {
36
37 /**
38 * Initializes the hook object
39 *
40 * @param browse_links Parent browse_links object
41 * @param array Additional parameters
42 * @return void
43 */
44 public function init($parentObject, $additionalParameters);
45
46 /**
47 * Adds new items to the currently allowed ones and returns them
48 *
49 * @param array Currently allowed items
50 * @return array Currently allowed items plus added items
51 */
52 public function addAllowedItems($currentlyAllowedItems);
53
54 /**
55 * Modifies the menu definition and returns it
56 *
57 * @param array Menu definition
58 * @return array Modified menu definition
59 */
60 public function modifyMenuDefinition($menuDefinition);
61
62 /**
63 * Returns a new tab for the browse links wizard
64 *
65 * @param string Current link selector action
66 * @return string A tab for the selected link action
67 */
68 public function getTab($linkSelectorAction);
69
70 /**
71 * Checks the current URL and determines what to do
72 *
73 * @param string $href
74 * @param string $siteUrl
75 * @param array $info
76 * @return array
77 */
78 public function parseCurrentUrl($href, $siteUrl, $info);
79
80 }
81
82 ?>