[TASK] Use real boolean value for sL second param
[Packages/TYPO3.CMS.git] / typo3 / sysext / core / Classes / Database / PreProcessQueryHookInterface.php
1 <?php
2 namespace TYPO3\CMS\Core\Database;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2011-2013 Xavier Perseguers <typo3@perseguers.ch>
8 * All rights reserved
9 *
10 * This script is part of the TYPO3 project. The TYPO3 project is
11 * free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation; either version 2 of the License, or
14 * (at your option) any later version.
15 *
16 * The GNU General Public License can be found at
17 * http://www.gnu.org/copyleft/gpl.html.
18 * A copy is found in the textfile GPL.txt and important notices to the license
19 * from the author is found in LICENSE.txt distributed with these scripts.
20 *
21 *
22 * This script is distributed in the hope that it will be useful,
23 * but WITHOUT ANY WARRANTY; without even the implied warranty of
24 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
25 * GNU General Public License for more details.
26 *
27 * This copyright notice MUST APPEAR in all copies of the script!
28 ***************************************************************/
29 /**
30 * Interface for classes which hook into \TYPO3\CMS\Core\Database\DatabaseConnection
31 * and do additional processing before a query has been executed.
32 *
33 * @author Xavier Perseguers <typo3@perseguers.ch>
34 */
35 interface PreProcessQueryHookInterface {
36 /**
37 * Pre-processor for the SELECTquery method.
38 *
39 * @param string $select_fields Fields to be selected
40 * @param string $from_table Table to select data from
41 * @param string $where_clause Where clause
42 * @param string $groupBy Group by statement
43 * @param string $orderBy Order by statement
44 * @param integer $limit Database return limit
45 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
46 * @return void
47 */
48 public function SELECTquery_preProcessAction(&$select_fields, &$from_table, &$where_clause, &$groupBy, &$orderBy, &$limit, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
49
50 /**
51 * Pre-processor for the INSERTquery method.
52 *
53 * @param string $table Database table name
54 * @param array $fieldsValues Field values as key => value pairs
55 * @param string/array $noQuoteFields List/array of keys NOT to quote
56 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
57 * @return void
58 */
59 public function INSERTquery_preProcessAction(&$table, array &$fieldsValues, &$noQuoteFields, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
60
61 /**
62 * Pre-processor for the INSERTmultipleRows method.
63 * BEWARE: When using DBAL, this hook will not be called at all. Instead,
64 * INSERTquery_preProcessAction() will be invoked for each row.
65 *
66 * @param string $table Database table name
67 * @param array $fields Field names
68 * @param array $rows Table rows
69 * @param string/array $noQuoteFields List/array of keys NOT to quote
70 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
71 * @return void
72 */
73 public function INSERTmultipleRows_preProcessAction(&$table, array &$fields, array &$rows, &$noQuoteFields, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
74
75 /**
76 * Pre-processor for the UPDATEquery method.
77 *
78 * @param string $table Database table name
79 * @param string $where WHERE clause
80 * @param array $fieldsValues Field values as key => value pairs
81 * @param string/array $noQuoteFields List/array of keys NOT to quote
82 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
83 * @return void
84 */
85 public function UPDATEquery_preProcessAction(&$table, &$where, array &$fieldsValues, &$noQuoteFields, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
86
87 /**
88 * Pre-processor for the DELETEquery method.
89 *
90 * @param string $table Database table name
91 * @param string $where WHERE clause
92 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
93 * @return void
94 */
95 public function DELETEquery_preProcessAction(&$table, &$where, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
96
97 /**
98 * Pre-processor for the TRUNCATEquery method.
99 *
100 * @param string $table Database table name
101 * @param \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject
102 * @return void
103 */
104 public function TRUNCATEquery_preProcessAction(&$table, \TYPO3\CMS\Core\Database\DatabaseConnection $parentObject);
105
106 }
107
108 ?>