BackendInterface.php 2.75 KB
Newer Older
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
1
2
<?php
/***************************************************************
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 *  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!
 ***************************************************************/
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
27
28
29
30
/**
 * Storage backend interface
 *
 * @package Extbase
31
 * @subpackage Persistence\Storage
32
 * @version $Id$
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
33
 */
34
35
interface Tx_Extbase_Persistence_Storage_BackendInterface
{
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
36
37
38
39
40
	/**
	 * 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
41
	 * @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
42
43
	 * @return void
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
44
	public function addRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
45
46
47
48
49
50

	/**
	 * 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
51
	 * @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
52
53
	 * @return void
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
54
	public function updateRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
55
56
57
58
59

	/**
	 * Deletes a row in the storage
	 *
	 * @param string $tableName The database table name
60
	 * @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
61
	 * @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
62
63
	 * @return void
	 */
64
	public function removeRow($tableName, array $identifier, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
65
66

	/**
67
	 * Returns the number of items matching the query.
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
68
	 *
69
70
71
	 * @param Tx_Extbase_Persistence_QueryInterface $query
	 * @return integer
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
72
	 */
73
	public function getObjectCountByQuery(Tx_Extbase_Persistence_QueryInterface $query);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
74

75
	/**
76
	 * Returns the object data matching the $query.
77
	 *
78
79
80
	 * @param Tx_Extbase_Persistence_QueryInterface $query
	 * @return array
	 * @api
81
	 */
82
	public function getObjectDataByQuery(Tx_Extbase_Persistence_QueryInterface $query);
83

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