[TASK] Respect editlock of pages in inline editing
[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 interface RecordListHookInterface {
21
22 /**
23 * Modifies Web>List clip icons (copy, cut, paste, etc.) of a displayed row
24 *
25 * @param string $table The current database table
26 * @param array $row The current record row
27 * @param array $cells The default clip-icons to get modified
28 * @param object $parentObject Instance of calling object
29 * @return array The modified clip-icons
30 */
31 public function makeClip($table, $row, $cells, &$parentObject);
32
33 /**
34 * Modifies Web>List control icons of a displayed row
35 *
36 * @param string $table The current database table
37 * @param array $row The current record row
38 * @param array $cells The default control-icons to get modified
39 * @param object $parentObject Instance of calling object
40 * @return array The modified control-icons
41 */
42 public function makeControl($table, $row, $cells, &$parentObject);
43
44 /**
45 * Modifies Web>List header row columns/cells
46 *
47 * @param string $table The current database table
48 * @param array $currentIdList Array of the currently displayed uids of the table
49 * @param array $headerColumns An array of rendered cells/columns
50 * @param object $parentObject Instance of calling (parent) object
51 * @return array Array of modified cells/columns
52 */
53 public function renderListHeader($table, $currentIdList, $headerColumns, &$parentObject);
54
55 /**
56 * Modifies Web>List header row clipboard/action icons
57 *
58 * @param string $table The current database table
59 * @param array $currentIdList Array of the currently displayed uids of the table
60 * @param array $cells An array of the current clipboard/action icons
61 * @param object $parentObject Instance of calling (parent) object
62 * @return array Array of modified clipboard/action icons
63 */
64 public function renderListHeaderActions($table, $currentIdList, $cells, &$parentObject);
65
66 }