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