[TASK] Clean up the phpDoc of t3lib/interfaces/
[Packages/TYPO3.CMS.git] / t3lib / interfaces / interface.t3lib_db_preprocessqueryhook.php
1 <?php
2 /***************************************************************
3 * Copyright notice
4 *
5 * (c) 2011 Xavier Perseguers <typo3@perseguers.ch>
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 t3lib_DB and do additional processing
30 * before a query has been executed.
31 *
32 * @author Xavier Perseguers <typo3@perseguers.ch>
33 * @package TYPO3
34 * @subpackage t3lib
35 */
36 interface t3lib_DB_preProcessQueryHook {
37
38 /**
39 * Pre-processor for the INSERTquery method.
40 *
41 * @param string $table Database table name
42 * @param array $fieldsValues Field values as key => value pairs
43 * @param string/array $noQuoteFields List/array of keys NOT to quote
44 * @param t3lib_DB $parentObject
45 * @return void
46 */
47 public function INSERTquery_preProcessAction(&$table, array &$fieldsValues, &$noQuoteFields, t3lib_DB $parentObject);
48
49 /**
50 * Pre-processor for the INSERTmultipleRows method.
51 * BEWARE: When using DBAL, this hook will not be called at all. Instead,
52 * INSERTquery_preProcessAction() will be invoked for each row.
53 *
54 * @param string $table Database table name
55 * @param array $fields Field names
56 * @param array $rows Table rows
57 * @param string/array $noQuoteFields List/array of keys NOT to quote
58 * @param t3lib_DB $parentObject
59 * @return void
60 */
61 public function INSERTmultipleRows_preProcessAction(&$table, array &$fields, array &$rows, &$noQuoteFields, t3lib_DB $parentObject);
62
63 /**
64 * Pre-processor for the UPDATEquery method.
65 *
66 * @param string $table Database table name
67 * @param string $where WHERE clause
68 * @param array $fieldsValues Field values as key => value pairs
69 * @param string/array $noQuoteFields List/array of keys NOT to quote
70 * @param t3lib_DB $parentObject
71 * @return void
72 */
73 public function UPDATEquery_preProcessAction(&$table, &$where, array &$fieldsValues, &$noQuoteFields, t3lib_DB $parentObject);
74
75 /**
76 * Pre-processor for the DELETEquery method.
77 *
78 * @param string $table Database table name
79 * @param string $where WHERE clause
80 * @param t3lib_DB $parentObject
81 * @return void
82 */
83 public function DELETEquery_preProcessAction(&$table, &$where, t3lib_DB $parentObject);
84
85 /**
86 * Pre-processor for the TRUNCATEquery method.
87 *
88 * @param string $table Database table name
89 * @param t3lib_DB $parentObject
90 * @return void
91 */
92 public function TRUNCATEquery_preProcessAction(&$table, t3lib_DB $parentObject);
93
94 }
95
96 ?>