BackendInterface.php 2.91 KB
Newer Older
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
1
<?php
Thomas Maroschik's avatar
Thomas Maroschik committed
2
3
namespace TYPO3\CMS\Extbase\Persistence\Generic\Storage;

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
4
/***************************************************************
5
6
 *  Copyright notice
 *
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
10
11
12
13
14
15
16
17
18
 *  All rights reserved
 *
 *  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.
19
20
21
 *  A copy is found in the textfile GPL.txt and important notices to the license
 *  from the author is found in LICENSE.txt distributed with these scripts.
 *
22
23
24
25
26
27
28
29
 *
 *  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
30
31
32
/**
 * Storage backend interface
 */
33
34
interface BackendInterface {

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
35
36
37
38
39
	/**
	 * 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
40
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
41
	 * @return mixed|void
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
42
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
43
	public function addRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
44
45
46
47
48
49

	/**
	 * 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
50
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
51
	 * @return mixed|void
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
52
	 */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
53
	public function updateRow($tableName, array $row, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
54
55
56
57
58

	/**
	 * Deletes a row in the storage
	 *
	 * @param string $tableName The database table name
59
	 * @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
60
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
61
	 * @return mixed|void
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
62
	 */
63
	public function removeRow($tableName, array $identifier, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
64
65

	/**
66
	 * Returns the number of items matching the query.
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
67
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
68
	 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
69
70
	 * @return integer
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
71
	 */
Thomas Maroschik's avatar
Thomas Maroschik committed
72
	public function getObjectCountByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
73

74
	/**
75
	 * Returns the object data matching the $query.
76
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
77
	 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
78
79
	 * @return array
	 * @api
80
	 */
Thomas Maroschik's avatar
Thomas Maroschik committed
81
	public function getObjectDataByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
82
}
Thomas Maroschik's avatar
Thomas Maroschik committed
83

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