* (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
/**
* A persistence query interface
*
- * @package TYPO3
- * @subpackage Extbase
+ * @package Extbase
+ * @subpackage Persistence
* @version $Id$
+ * @api
*/
interface Tx_Extbase_Persistence_QueryInterface {
+ /**
+ * The '=' comparison operator.
+ * @api
+ */
+ const OPERATOR_EQUAL_TO = 1;
+
+ /**
+ * The '!=' comparison operator.
+ * @api
+ */
+ const OPERATOR_NOT_EQUAL_TO = 2;
+
+ /**
+ * The '<' comparison operator.
+ * @api
+ */
+ const OPERATOR_LESS_THAN = 3;
+
+ /**
+ * The '<=' comparison operator.
+ * @api
+ */
+ const OPERATOR_LESS_THAN_OR_EQUAL_TO = 4;
+
+ /**
+ * The '>' comparison operator.
+ * @api
+ */
+ const OPERATOR_GREATER_THAN = 5;
+
+ /**
+ * The '>=' comparison operator.
+ * @api
+ */
+ const OPERATOR_GREATER_THAN_OR_EQUAL_TO = 6;
+
+ /**
+ * The 'like' comparison operator.
+ * @api
+ */
+ const OPERATOR_LIKE = 7;
+
+ /**
+ * The 'contains' comparison operator.
+ * @api
+ */
+ const OPERATOR_CONTAINS = 8;
+
+ /**
+ * The 'in' comparison operator.
+ * @api
+ */
+ const OPERATOR_IN = 9;
+
+ /**
+ * Constants representing the direction when ordering result sets.
+ */
+ const ORDER_ASCENDING = 'ASC';
+ const ORDER_DESCENDING = 'DESC';
+
+ /**
+ * 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';
+
/**
* Executes the query against the backend and returns the result
*
- * @return array The query result, an array of objects
+ * @return array<object> The query result as an array of objects
+ * @api
*/
public function execute();
-
+
/**
- * The constraint used to limit the result set
+ * Executes the query against the database and returns the number of matching objects
*
- * @param Tx_Extbase_Persistence_ConstraintInterface $constraint Some constraint, depending on the backend
+ * @return integer The number of matching objects
+ * @api
+ */
+ public function count();
+
+ /**
+ * Sets the property names to order the result by. Expected like this:
+ * array(
+ * 'foo' => Tx_Extbase_Persistence_QueryInterface::ORDER_ASCENDING,
+ * 'bar' => Tx_Extbase_Persistence_QueryInterface::ORDER_DESCENDING
+ * )
+ *
+ * @param array $orderings The property names to order by
* @return Tx_Extbase_Persistence_QueryInterface
+ * @api
+ */
+ 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
+ * @return Tx_Extbase_Persistence_QueryInterface
+ * @api
+ */
+ 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
+ * @return Tx_Extbase_Persistence_QueryInterface
+ * @api
+ */
+ 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
+ * @return Tx_Extbase_Persistence_QueryInterface
+ * @api
+ */
+ public function matching($constraint);
+
+ /**
+ * Performs a logical conjunction of the two given constraints.
+ *
+ * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
+ * @return object
+ * @api
+ */
+ public function logicalAnd($constraint1);
+
+ /**
+ * Performs a logical disjunction of the two given constraints
+ *
+ * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
+ * @return object
+ * @api
+ */
+ public function logicalOr($constraint1);
+
+ /**
+ * Performs a logical negation of the given constraint
+ *
+ * @param object $constraint Constraint to negate
+ * @return object
+ * @api
+ */
+ public function logicalNot($constraint);
+
+ /**
+ * Matches against the (internal) identifier.
+ *
+ * @param string $uid An identifier to match against
+ * @return object
+ * @api
+ */
+ public function withUid($uid);
+
+ /**
+ * 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
+ * @api
+ */
+ 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
+ * @api
+ */
+ public function like($propertyName, $operand);
+
+ /**
+ * 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);
+
+ /**
+ * 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
+ * @api
+ */
+ 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
+ * @api
+ */
+ 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
+ * @api
+ */
+ 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
+ * @api
*/
- public function matching(Tx_Extbase_Persistence_ConstraintInterface $constraint);
+ public function greaterThanOrEqual($propertyName, $operand);
}
?>
\ No newline at end of file
projects / Packages / TYPO3.CMS.git / blobdiff