[TASK] Move classAliasMaps into compatibility6 extension part 6
[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 /**
18 * Interface for classes which hook into \TYPO3\CMS\Recordlist\RecordList\DatabaseRecordList and modify clip-icons
19 *
20 * @author Bernhard Kraft <kraftb@kraftb.at>
21 */
22 interface RecordListHookInterface {
23
24 /**
25 * Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
26 *
27 * @param string $table The current database table
28 * @param array $row The current record row
29 * @param array $cells The default clip-icons to get modified
30 * @param object $parentObject Instance of calling object
31 * @return array The modified clip-icons
32 */
33 public function makeClip($table, $row, $cells, &$parentObject);
34
35 /**
36 * Modifies Web>List control icons of a displayed row
37 *
38 * @param string $table The current database table
39 * @param array $row The current record row
40 * @param array $cells The default control-icons to get modified
41 * @param object $parentObject Instance of calling object
42 * @return array The modified control-icons
43 */
44 public function makeControl($table, $row, $cells, &$parentObject);
45
46 /**
47 * Modifies Web>List header row columns/cells
48 *
49 * @param string $table The current database table
50 * @param array $currentIdList Array of the currently displayed uids of the table
51 * @param array $headerColumns An array of rendered cells/columns
52 * @param object $parentObject Instance of calling (parent) object
53 * @return array Array of modified cells/columns
54 */
55 public function renderListHeader($table, $currentIdList, $headerColumns, &$parentObject);
56
57 /**
58 * Modifies Web>List header row clipboard/action icons
59 *
60 * @param string $table The current database table
61 * @param array $currentIdList Array of the currently displayed uids of the table
62 * @param array $cells An array of the current clipboard/action icons
63 * @param object $parentObject Instance of calling (parent) object
64 * @return array Array of modified clipboard/action icons
65 */
66 public function renderListHeaderActions($table, $currentIdList, $cells, &$parentObject);
67
68 }