BackendInterface.php 4.07 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
 *  A copy is found in the text file GPL.txt and important notices to the license
20
21
 *  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
	/**
	 * Adds a row to the storage
	 *
	 * @param string $tableName The database table name
39
	 * @param array $fieldValues The fieldValues 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 integer the UID of the inserted row
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
42
	 */
43
	public function addRow($tableName, array $fieldValues, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
44
45
46
47
48

	/**
	 * Updates a row in the storage
	 *
	 * @param string $tableName The database table name
49
	 * @param array $fieldValues The fieldValues 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
	 */
53
	public function updateRow($tableName, array $fieldValues, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
54

55
56
57
58
	/**
	 * Updates a relation row in the storage
	 *
	 * @param string $tableName The database relation table name
59
	 * @param array $fieldValues The fieldValues to be updated
60
61
	 * @return boolean
	 */
62
	public function updateRelationTableRow($tableName, array $fieldValues);
63

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
64
65
66
67
	/**
	 * Deletes a row in the storage
	 *
	 * @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
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
69
	 * @param boolean $isRelation TRUE if we are currently inserting into a relation table, FALSE by default
70
	 * @return mixed|void
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
71
	 */
72
	public function removeRow($tableName, array $where, $isRelation = FALSE);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
73

74
75
76
77
	/**
	 * Fetches maximal value for given table column
	 *
	 * @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
80
81
	 * @param string $columnName column name to get the max value from
	 * @return mixed the max value
	 */
82
	public function getMaxValueFromTable($tableName, array $where, $columnName);
83

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
84
	/**
85
	 * Returns the number of items matching the query.
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
86
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
87
	 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
88
89
	 * @return integer
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
90
	 */
Thomas Maroschik's avatar
Thomas Maroschik committed
91
	public function getObjectCountByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
92

93
	/**
94
	 * Returns the object data matching the $query.
95
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
96
	 * @param \TYPO3\CMS\Extbase\Persistence\QueryInterface $query
97
98
	 * @return array
	 * @api
99
	 */
Thomas Maroschik's avatar
Thomas Maroschik committed
100
	public function getObjectDataByQuery(\TYPO3\CMS\Extbase\Persistence\QueryInterface $query);
101
102
103
104
105
106
107
108
109

	/**
	 * Checks if a Value Object equal to the given Object exists in the data base
	 *
	 * @param \TYPO3\CMS\Extbase\DomainObject\AbstractValueObject $object The Value Object
	 * @return mixed The matching uid if an object was found, else FALSE
	 * @todo this is the last monster in this persistence series. refactor!
	 */
	public function getUidOfAlreadyPersistedValueObject(\TYPO3\CMS\Extbase\DomainObject\AbstractValueObject $object);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
110
}