[TASK] Clean up the phpDoc of t3lib/interfaces/
[Packages/TYPO3.CMS.git] / t3lib / interfaces / interface.t3lib_localrecordlistgettablehook.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 localRecordList and do additional getTable processing
30 *
31 * @author Ingo Renner <ingo@typo3.org>
32 * @package TYPO3
33 * @subpackage t3lib
34 */
35 interface t3lib_localRecordListGetTableHook {
36
37 /**
38 * modifies the DB list query
39 *
40 * @param string $table The current database table
41 * @param integer $pageId The record's page ID
42 * @param string $additionalWhereClause An additional WHERE clause
43 * @param string $selectedFieldsList Comma separated list of selected fields
44 * @param localRecordList $parentObject Parent localRecordList object
45 * @return void
46 */
47 public function getDBlistQuery($table, $pageId, &$additionalWhereClause, &$selectedFieldsList, &$parentObject);
48
49 }
50
51 ?>