[TASK] Streamline phpdoc annotations in EXT:extbase
[Packages/TYPO3.CMS.git] / typo3 / sysext / extbase / Classes / Persistence / Generic / Query.php
index a74d4a5..2624d02 100644 (file)
@@ -18,8 +18,6 @@ use TYPO3\CMS\Extbase\Persistence\QueryInterface;
 
 /**
  * The Query class used to run queries against the database
- *
- * @api
  */
 class Query implements QueryInterface
 {
@@ -176,7 +174,6 @@ class Query implements QueryInterface
      * the specific Storage Backend.
      *
      * @param QuerySettingsInterface $querySettings The Query Settings
-     * @api This method is not part of TYPO3.Flow API
      */
     public function setQuerySettings(QuerySettingsInterface $querySettings)
     {
@@ -188,7 +185,6 @@ class Query implements QueryInterface
      *
      * @throws Exception
      * @return QuerySettingsInterface $querySettings The Query Settings
-     * @api This method is not part of TYPO3.Flow API
      */
     public function getQuerySettings()
     {
@@ -202,7 +198,6 @@ class Query implements QueryInterface
      * Returns the type this query cares for.
      *
      * @return string
-     * @api
      */
     public function getType()
     {
@@ -252,7 +247,6 @@ class Query implements QueryInterface
      *
      * @param bool $returnRawQueryResult avoids the object mapping by the persistence
      * @return \TYPO3\CMS\Extbase\Persistence\QueryResultInterface|array The query result object or an array if $returnRawQueryResult is TRUE
-     * @api
      */
     public function execute($returnRawQueryResult = false)
     {
@@ -272,7 +266,6 @@ class Query implements QueryInterface
      *
      * @param array $orderings The property names to order by
      * @return QueryInterface
-     * @api
      */
     public function setOrderings(array $orderings)
     {
@@ -288,7 +281,6 @@ class Query implements QueryInterface
      * )
      *
      * @return int
-     * @api
      */
     public function getOrderings()
     {
@@ -302,7 +294,6 @@ class Query implements QueryInterface
      * @param int $limit
      * @throws \InvalidArgumentException
      * @return QueryInterface
-     * @api
      */
     public function setLimit($limit)
     {
@@ -318,7 +309,6 @@ class Query implements QueryInterface
      * for chaining (fluid interface)
      *
      * @return QueryInterface
-     * @api
      */
     public function unsetLimit()
     {
@@ -330,7 +320,6 @@ class Query implements QueryInterface
      * Returns the maximum size of the result set to limit.
      *
      * @return int
-     * @api
      */
     public function getLimit()
     {
@@ -344,7 +333,6 @@ class Query implements QueryInterface
      * @param int $offset
      * @throws \InvalidArgumentException
      * @return QueryInterface
-     * @api
      */
     public function setOffset($offset)
     {
@@ -359,7 +347,6 @@ class Query implements QueryInterface
      * Returns the start offset of the result set.
      *
      * @return int
-     * @api
      */
     public function getOffset()
     {
@@ -372,7 +359,6 @@ class Query implements QueryInterface
      *
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface $constraint
      * @return QueryInterface
-     * @api
      */
     public function matching($constraint)
     {
@@ -408,7 +394,6 @@ class Query implements QueryInterface
      * Gets the constraint for this query.
      *
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface|null the constraint, or null if none
-     * @api
      */
     public function getConstraint()
     {
@@ -422,7 +407,6 @@ class Query implements QueryInterface
      * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
      * @throws Exception\InvalidNumberOfConstraintsException
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\AndInterface
-     * @api
      */
     public function logicalAnd($constraint1)
     {
@@ -448,7 +432,6 @@ class Query implements QueryInterface
      * @param mixed $constraint1 The first of multiple constraints or an array of constraints.
      * @throws Exception\InvalidNumberOfConstraintsException
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\OrInterface
-     * @api
      */
     public function logicalOr($constraint1)
     {
@@ -474,7 +457,6 @@ class Query implements QueryInterface
      * @param \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface $constraint Constraint to negate
      * @throws \RuntimeException
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\NotInterface
-     * @api
      */
     public function logicalNot(\TYPO3\CMS\Extbase\Persistence\Generic\Qom\ConstraintInterface $constraint)
     {
@@ -488,7 +470,6 @@ class Query implements QueryInterface
      * @param mixed $operand The value to compare with
      * @param bool $caseSensitive Whether the equality test should be done case-sensitive
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function equals($propertyName, $operand, $caseSensitive = true)
     {
@@ -514,7 +495,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function like($propertyName, $operand)
     {
@@ -532,7 +512,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the (multivalued) property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function contains($propertyName, $operand)
     {
@@ -547,7 +526,6 @@ class Query implements QueryInterface
      * @param mixed $operand The value to compare with, multivalued
      * @throws Exception\UnexpectedTypeException
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function in($propertyName, $operand)
     {
@@ -563,7 +541,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function lessThan($propertyName, $operand)
     {
@@ -576,7 +553,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function lessThanOrEqual($propertyName, $operand)
     {
@@ -589,7 +565,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function greaterThan($propertyName, $operand)
     {
@@ -602,7 +577,6 @@ class Query implements QueryInterface
      * @param string $propertyName The name of the property to compare against
      * @param mixed $operand The value to compare with
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\ComparisonInterface
-     * @api
      */
     public function greaterThanOrEqual($propertyName, $operand)
     {
@@ -617,7 +591,6 @@ class Query implements QueryInterface
      * @param mixed $operandUpper The value of the upper boundary to compare against
      * @return \TYPO3\CMS\Extbase\Persistence\Generic\Qom\AndInterface
      * @throws \TYPO3\CMS\Extbase\Persistence\Generic\Exception\InvalidNumberOfConstraintsException
-     * @api
      */
     public function between($propertyName, $operandLower, $operandUpper)
     {
@@ -628,6 +601,7 @@ class Query implements QueryInterface
     }
 
     /**
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function __wakeup()
     {
@@ -639,6 +613,7 @@ class Query implements QueryInterface
 
     /**
      * @return array
+     * @internal only to be used within Extbase, not part of TYPO3 Core API.
      */
     public function __sleep()
     {
@@ -649,7 +624,6 @@ class Query implements QueryInterface
      * Returns the query result count.
      *
      * @return int The query result count
-     * @api
      */
     public function count()
     {
@@ -662,7 +636,6 @@ class Query implements QueryInterface
      *
      * @param string $propertyName The name of the multivalued property to compare against
      * @throws Exception\NotImplementedException
-     * @api
      */
     public function isEmpty($propertyName)
     {