BackendInterface.php 2.77 KB
Newer Older
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
<?php
/***************************************************************
*  Copyright notice
*
*  (c) 2009 Jochen Rau <jochen.rau@typoplanet.de>
*  All rights reserved
*
*  This class is a backport of the corresponding class of FLOW3.
*  All credits go to the v5 team.
*
*  This script is part of the TYPO3 project. The TYPO3 project is
*  free software; you can redistribute it and/or modify
*  it under the terms of the GNU General Public License as published by
*  the Free Software Foundation; either version 2 of the License, or
*  (at your option) any later version.
*
*  The GNU General Public License can be found at
*  http://www.gnu.org/copyleft/gpl.html.
*
*  This script is distributed in the hope that it will be useful,
*  but WITHOUT ANY WARRANTY; without even the implied warranty of
*  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
*  GNU General Public License for more details.
*
*  This copyright notice MUST APPEAR in all copies of the script!
***************************************************************/

/**
 * Storage backend interface
 *
 * @package Extbase
32
 * @subpackage Persistence\Storage
33
 * @version $Id$
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
34
35
36
37
38
39
40
41
 */
interface Tx_Extbase_Persistence_Storage_BackendInterface {

	/**
	 * Adds a row to the storage
	 *
	 * @param string $tableName The database table name
	 * @param array $row The row to insert
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
42
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
43
44
	 * @return void
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
45
	public function addRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
46
47
48
49
50
51

	/**
	 * Updates a row in the storage
	 *
	 * @param string $tableName The database table name
	 * @param array $row The row to update
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
52
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
53
54
	 * @return void
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
55
	public function updateRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
56
57
58
59
60

	/**
	 * Deletes a row in the storage
	 *
	 * @param string $tableName The database table name
61
	 * @param array $identifier An array of identifier array('fieldname' => value). This array will be transformed to a WHERE clause
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
62
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
63
64
	 * @return void
	 */
65
	public function removeRow($tableName, array $identifier, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
66
67
68
69
70
71
72
73
74

	/**
	 * Returns an array with rows matching the query.
	 *
	 * @param Tx_Extbase_Persistence_QOM_QueryObjectModelInterface $query
	 * @return array
	 */
	public function getRows(Tx_Extbase_Persistence_QOM_QueryObjectModelInterface $query);

75
76
77
78
79
80
81
82
	/**
	 * Returns the number of tuples matching the query.
	 *
	 * @param Tx_Extbase_Persistence_QOM_QueryObjectModelInterface $query
	 * @return int The number of matching tuples
	 */
	public function countRows(Tx_Extbase_Persistence_QOM_QueryObjectModelInterface $query);

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
83
84
}
?>