[BUGFIX] Make Typo3DbBackend use DatabaseConnection
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Storage / BackendInterface.php
1 <?php
2 namespace TYPO3\CMS\Extbase\Persistence\Generic\Storage;
3
4 /***************************************************************
5 * Copyright notice
6 *
7 * (c) 2010-2013 Extbase Team (http://forge.typo3.org/projects/typo3v4-mvc)
8 * Extbase is a backport of TYPO3 Flow. All credits go to the TYPO3 Flow team.
9 * All rights reserved
10 *
11 * This script is part of the TYPO3 project. The TYPO3 project is
12 * free software; you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation; either version 2 of the License, or
15 * (at your option) any later version.
16 *
17 * The GNU General Public License can be found at
18 * http://www.gnu.org/copyleft/gpl.html.
19 * A copy is found in the text file GPL.txt and important notices to the license
20 * from the author is found in LICENSE.txt distributed with these scripts.
21 *
22 *
23 * This script is distributed in the hope that it will be useful,
24 * but WITHOUT ANY WARRANTY; without even the implied warranty of
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
26 * GNU General Public License for more details.
27 *
28 * This copyright notice MUST APPEAR in all copies of the script!
29 ***************************************************************/
30 /**
31 * Storage backend interface
32 */
33 interface BackendInterface {
34
35 /**
36 * Adds a row to the storage
37 *
38 * @param string $tableName The database table name
39 * @param array $fieldValues The fieldValues to insert
40 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
41 * @return integer the UID of the inserted row
42 */
43 public function addRow($tableName, array $fieldValues, $isRelation = FALSE);
44
45 /**
46 * Updates a row in the storage
47 *
48 * @param string $tableName The database table name
49 * @param array $fieldValues The fieldValues to update
50 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
51 * @return mixed|void
52 */
53 public function updateRow($tableName, array $fieldValues, $isRelation = FALSE);
54
55 /**
56 * Updates a relation row in the storage
57 *
58 * @param string $tableName The database relation table name
59 * @param array $fieldValues The fieldValues to be updated
60 * @return boolean
61 */
62 public function updateRelationTableRow($tableName, array $fieldValues);
63
64 /**
65 * Deletes a row in the storage
66 *
67 * @param string $tableName The database table name
68 * @param array $where An array of where array('fieldname' => value). This array will be transformed to a WHERE clause
69 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
70 * @return mixed|void
71 */
72 public function removeRow($tableName, array $where, $isRelation = FALSE);
73
74 /**
75 * Fetches maximal value for given table column
76 *
77 * @param string $tableName The database table name
78 * @param array $where An array of where array('fieldname' => value). This array will be transformed to a WHERE clause
79 * @param string $columnName column name to get the max value from
80 * @return mixed the max value
81 */
82 public function getMaxValueFromTable($tableName, array $where, $columnName);
83
84 /**
85 * Returns the number of items matching the query.
86 *
87 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
88 * @return integer
89 * @api
90 */
91 public function getObjectCountByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
92
93 /**
94 * Returns the object data matching the $query.
95 *
96 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
97 * @return array
98 * @api
99 */
100 public function getObjectDataByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
101 }