QueryInterface.php 8.08 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;

4
5
6
7
8
9
10
11
12
13
14
15
/*                                                                        *
 * This script belongs to the Extbase framework.                          *
 *                                                                        *
 * This class is a backport of the corresponding class of FLOW3.          *
 * All credits go to the v5 team.                                         *
 *                                                                        *
 * It is free software; you can redistribute it and/or modify it under    *
 * the terms of the GNU Lesser General Public License, either version 3   *
 * of the License, or (at your option) any later version.                 *
 *                                                                        *
 * The TYPO3 project - inspiring people to share!                         *
 *                                                                        */
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
16
17
18
/**
 * A persistence query interface
 *
19
 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
20
 */
Helmut Hummel's avatar
Helmut Hummel committed
21
interface QueryInterface {
22
23
	/**
	 * The '=' comparison operator.
24
	 *
25
	 * @api
26
	 */
27
28
29
	const OPERATOR_EQUAL_TO = 1;
	/**
	 * The '!=' comparison operator.
30
	 *
31
	 * @api
32
	 */
33
34
35
	const OPERATOR_NOT_EQUAL_TO = 2;
	/**
	 * The '<' comparison operator.
36
	 *
37
	 * @api
38
	 */
39
40
41
	const OPERATOR_LESS_THAN = 3;
	/**
	 * The '<=' comparison operator.
42
	 *
43
	 * @api
44
	 */
45
46
47
	const OPERATOR_LESS_THAN_OR_EQUAL_TO = 4;
	/**
	 * The '>' comparison operator.
48
	 *
49
	 * @api
50
	 */
51
52
53
	const OPERATOR_GREATER_THAN = 5;
	/**
	 * The '>=' comparison operator.
54
	 *
55
	 * @api
56
	 */
57
58
59
	const OPERATOR_GREATER_THAN_OR_EQUAL_TO = 6;
	/**
	 * The 'like' comparison operator.
60
	 *
61
	 * @api
62
	 */
63
64
65
	const OPERATOR_LIKE = 7;
	/**
	 * The 'contains' comparison operator.
66
	 *
67
	 * @api
68
	 */
69
70
71
	const OPERATOR_CONTAINS = 8;
	/**
	 * The 'in' comparison operator.
72
	 *
73
	 * @api
74
	 */
75
	const OPERATOR_IN = 9;
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
76
77
78
79
80
	/**
	 * Constants representing the direction when ordering result sets.
	 */
	const ORDER_ASCENDING = 'ASC';
	const ORDER_DESCENDING = 'DESC';
81
82
83
84
85
86
87
88
89
90
91
92
	/**
	 * An inner join.
	 */
	const JCR_JOIN_TYPE_INNER = '{http://www.jcp.org/jcr/1.0}joinTypeInner';
	/**
	 * A left-outer join.
	 */
	const JCR_JOIN_TYPE_LEFT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeLeftOuter';
	/**
	 * A right-outer join.
	 */
	const JCR_JOIN_TYPE_RIGHT_OUTER = '{http://www.jcp.org/jcr/1.0}joinTypeRightOuter';
93
94
95
96
	/**
	 * Charset of strings in QOM
	 */
	const CHARSET = 'utf-8';
97
98
99
	/**
	 * Gets the node-tuple source for this query.
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
100
	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\SourceInterface the node-tuple source; non-NULL
101
102
103
	 */
	public function getSource();

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
104
105
106
	/**
	 * Executes the query against the backend and returns the result
	 *
107
	 * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $this->getQuerySettings()->getReturnRawQueryResult() is TRUE
108
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
109
110
111
112
113
114
	 */
	public function execute();

	/**
	 * Sets the property names to order the result by. Expected like this:
	 * array(
115
116
	 * 'foo' => Tx_Extbase_Persistence_QueryInterface::ORDER_ASCENDING,
	 * 'bar' => Tx_Extbase_Persistence_QueryInterface::ORDER_DESCENDING
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
117
118
119
	 * )
	 *
	 * @param array $orderings The property names to order by
Thomas Maroschik's avatar
Thomas Maroschik committed
120
	 * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
121
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
122
123
124
125
126
127
128
129
	 */
	public function setOrderings(array $orderings);

	/**
	 * Sets the maximum size of the result set to limit. Returns $this to allow
	 * for chaining (fluid interface)
	 *
	 * @param integer $limit
Thomas Maroschik's avatar
Thomas Maroschik committed
130
	 * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
131
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
132
133
134
135
136
137
138
139
	 */
	public function setLimit($limit);

	/**
	 * Sets the start offset of the result set to offset. Returns $this to
	 * allow for chaining (fluid interface)
	 *
	 * @param integer $offset
Thomas Maroschik's avatar
Thomas Maroschik committed
140
	 * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
141
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
142
143
144
145
146
147
148
149
	 */
	public function setOffset($offset);

	/**
	 * The constraint used to limit the result set. Returns $this to allow
	 * for chaining (fluid interface)
	 *
	 * @param object $constraint Some constraint, depending on the backend
Thomas Maroschik's avatar
Thomas Maroschik committed
150
	 * @return \TYPO3\CMS\Extbase\Persistence\QueryInterface
151
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
152
153
154
155
156
157
	 */
	public function matching($constraint);

	/**
	 * Performs a logical conjunction of the two given constraints.
	 *
158
	 * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
159
	 * @return object
160
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
161
	 */
162
	public function logicalAnd($constraint1);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
163
164
165
166

	/**
	 * Performs a logical disjunction of the two given constraints
	 *
167
	 * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
168
	 * @return object
169
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
170
	 */
171
	public function logicalOr($constraint1);
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
172
173
174
175
176
177

	/**
	 * Performs a logical negation of the given constraint
	 *
	 * @param object $constraint Constraint to negate
	 * @return object
178
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
179
180
181
182
183
184
185
186
187
188
	 */
	public function logicalNot($constraint);

	/**
	 * Returns an equals criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @param boolean $caseSensitive Whether the equality test should be done case-sensitive
	 * @return object
189
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
190
191
192
193
194
195
196
197
198
	 */
	public function equals($propertyName, $operand, $caseSensitive = TRUE);

	/**
	 * Returns a like criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
199
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
200
201
202
	 */
	public function like($propertyName, $operand);

203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
	/**
	 * Returns a "contains" criterion used for matching objects against a query.
	 * It matches if the multivalued property contains the given operand.
	 *
	 * @param string $propertyName The name of the (multivalued) property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
	 * @api
	 */
	public function contains($propertyName, $operand);

	/**
	 * Returns an "in" criterion used for matching objects against a query. It
	 * matches if the property's value is contained in the multivalued operand.
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with, multivalued
	 * @return object
	 * @api
	 */
	public function in($propertyName, $operand);

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
225
226
227
228
229
230
	/**
	 * Returns a less than criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
231
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
232
233
234
235
236
237
238
239
240
	 */
	public function lessThan($propertyName, $operand);

	/**
	 * Returns a less or equal than criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
241
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
242
243
244
245
246
247
248
249
250
	 */
	public function lessThanOrEqual($propertyName, $operand);

	/**
	 * Returns a greater than criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
251
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
252
253
254
255
256
257
258
259
260
	 */
	public function greaterThan($propertyName, $operand);

	/**
	 * Returns a greater than or equal criterion used for matching objects against a query
	 *
	 * @param string $propertyName The name of the property to compare against
	 * @param mixed $operand The value to compare with
	 * @return object
261
	 * @api
Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
262
263
264
	 */
	public function greaterThanOrEqual($propertyName, $operand);

265
266
267
268
269
270
271
272
273
274
275
276
	/**
	 * Returns the type this query cares for.
	 *
	 * @return string
	 * @api
	 */
	public function getType();

	/**
	 * Sets the Query Settings. These Query settings must match the settings expected by
	 * the specific Storage Backend.
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
277
	 * @param \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings The Query Settings
278
279
280
	 * @return void
	 * @api This method is not part of FLOW3 API
	 */
Thomas Maroschik's avatar
Thomas Maroschik committed
281
	public function setQuerySettings(\TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings);
282
283
284
285

	/**
	 * Returns the Query Settings.
	 *
Thomas Maroschik's avatar
Thomas Maroschik committed
286
	 * @return \TYPO3\CMS\Extbase\Persistence\Generic\QuerySettingsInterface $querySettings The Query Settings
287
288
289
	 * @api This method is not part of FLOW3 API
	 */
	public function getQuerySettings();
290

Sebastian Kurfürst's avatar
Sebastian Kurfürst committed
291
}
Thomas Maroschik's avatar
Thomas Maroschik committed
292

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