[TASK] Re-work/simplify copyright header in PHP files - Part 2
[Packages/TYPO3.CMS.git] / typo3 / sysext / recordlist / Classes / RecordList / RecordListHookInterface.php
1 <?php
2 namespace TYPO3\CMS\Recordlist\RecordList;
3
4 /**
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16 /**
17 * Interface for classes which hook into localRecordList and modify clip-icons
18 *
19 * @author Bernhard Kraft <kraftb@kraftb.at>
20 */
21 interface RecordListHookInterface
22 {
23 /**
24 * Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
25 *
26 * @param string $table The current database table
27 * @param array $row The current record row
28 * @param array $cells The default clip-icons to get modified
29 * @param object $parentObject Instance of calling object
30 * @return array The modified clip-icons
31 */
32 public function makeClip($table, $row, $cells, &$parentObject);
33
34 /**
35 * Modifies Web>List control icons of a displayed row
36 *
37 * @param string $table The current database table
38 * @param array $row The current record row
39 * @param array $cells The default control-icons to get modified
40 * @param object $parentObject Instance of calling object
41 * @return array The modified control-icons
42 */
43 public function makeControl($table, $row, $cells, &$parentObject);
44
45 /**
46 * Modifies Web>List header row columns/cells
47 *
48 * @param string $table The current database table
49 * @param array $currentIdList Array of the currently displayed uids of the table
50 * @param array $headerColumns An array of rendered cells/columns
51 * @param object $parentObject Instance of calling (parent) object
52 * @return array Array of modified cells/columns
53 */
54 public function renderListHeader($table, $currentIdList, $headerColumns, &$parentObject);
55
56 /**
57 * Modifies Web>List header row clipboard/action icons
58 *
59 * @param string $table The current database table
60 * @param array $currentIdList Array of the currently displayed uids of the table
61 * @param array $cells An array of the current clipboard/action icons
62 * @param object $parentObject Instance of calling (parent) object
63 * @return array Array of modified clipboard/action icons
64 */
65 public function renderListHeaderActions($table, $currentIdList, $cells, &$parentObject);
66
67 }