macroparts / vortex

src/Vortex.php

Doc Comments +45 added lines, -41 removed lines

@@ -300,7 +300,7 @@ 
      * So when we overwrite whitelists locally they are still including all the elements from core adapters.
      *
      * @param null|string $class
-     * @param $propertyname
+     * @param string $propertyname
      * @return array
      */
     private function getStaticPropertyOfClassMergedWithParents($class, $propertyname)
@@ -562,7 +562,7 @@ 
      * as the value. Includes that are nested inside included collections are grouped and added as additional params
      * to the included collection.
      *
-     * @param $string
+     * @param string $string
      * @param $availableIncludes
      * @return array
      */
@@ -778,7 +778,7 @@ 
      *
      * @param $includeName
      * @param $availableIncludes
-     * @return bool|string
+     * @return false|string
      */
     private function pathForNestedInclude($includeName, $availableIncludes)
     {
@@ -910,6 +910,10 @@ 
      */
     abstract protected function initIncompleteStatement($currentUser);
 
+    /**
+     * @param string $filterString
+     * @param string $language
+     */
     private function createIncompleteStatement(
         $currentUser,
         $filterString,
@@ -1152,7 +1156,7 @@ 
      * @param int $limit
      * @param int $page
      * @param string $filterMode
-     * @return QueryBuilder
+     * @return \Doctrine\ORM\QueryBuilder
      */
     public function getQueryBuilderFromFindMultiple(
         $currentUser,
@@ -1367,7 +1371,7 @@ 
      * and returns the qurey builder instance
      *
      * @param \UnserAller_Model_User $currentUser
-     * @param $language
+     * @param string $language
      * @param \Doctrine\ORM\QueryBuilder $incompleteStatement
      * @param string $includeString
      * @param string $orderString
@@ -1481,7 +1485,7 @@ 
      * @uses getFallbackLanguage
      * @uses getRequestedLanguage
      * @param $language
-     * @return callable
+     * @return string
      */
     private function getItemLanguageGetter($language)
     {
@@ -1503,7 +1507,7 @@ 
      *
      * @param array $result
      * @param \UnserAller_Model_User $currentUser
-     * @param $language
+     * @param string $language
      * @param array $meta
      * @param int $metaOnObjectLevelOption
      * @return array
@@ -1637,9 +1641,9 @@ 
      * @param $scheduledFixes
      * @param $currentUser
      * @param $meta
-     * @param $collectionNestingMethod
+     * @param string $collectionNestingMethod
      * @param $language
-     * @param $itemLanguageGetter
+     * @param string $itemLanguageGetter
      * @param int $metaOnObjectLevelOption
      * @uses retrieveNestedCollection
      * @uses retrieveNestedCollectionAndMergeMeta
@@ -1770,7 +1774,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
@@ -1944,7 +1948,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function entityIsExpression($query, $field, $params, $alias)
     {
@@ -1956,7 +1960,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityIsOrNullExpression($query, $field, $params, $alias)
     {
@@ -1972,7 +1976,7 @@ 
      * @param array $params
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
-     * @return mixed
+     * @return Query\Expr\Comparison
      * @throws \UnserAllerLib_Api_V4_Exception_UserRequiredButNotAuthenticated
      */
     private function entityMeExpression($query, $field, $params, $alias, $currentUser)
@@ -2042,7 +2046,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLtExpression($query, $field, $params, $alias)
     {
@@ -2062,7 +2066,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLteExpression($query, $field, $params, $alias)
     {
@@ -2082,7 +2086,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGtExpression($query, $field, $params, $alias)
     {
@@ -2102,7 +2106,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGteExpression($query, $field, $params, $alias)
     {
@@ -2313,7 +2317,7 @@ 
     }
 
     /**
-     * @param $prefix
+     * @param string $prefix
      * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
@@ -2339,7 +2343,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -2354,7 +2358,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -2366,7 +2370,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -2381,7 +2385,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -2401,7 +2405,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -2448,7 +2452,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -2472,7 +2476,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -2496,7 +2500,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -2511,7 +2515,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryIsExpression($query, $subquery, $params, $alias)
     {
@@ -2523,7 +2527,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function dateIsExpression($query, $field, $params, $alias)
     {
@@ -2535,7 +2539,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function integerIsExpression($query, $field, $params, $alias)
     {
@@ -2547,7 +2551,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringIsExpression($query, $field, $params, $alias)
     {
@@ -2596,7 +2600,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringNotExpression($query, $field, $params, $alias)
     {
@@ -2686,7 +2690,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainsExpression($query, $field, $params, $alias)
     {
@@ -2707,7 +2711,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainExpression($query, $field, $params, $alias)
     {
@@ -2719,7 +2723,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLtExpression($query, $field, $params, $alias)
     {
@@ -2739,7 +2743,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLtExpression($query, $field, $params, $alias)
     {
@@ -2759,7 +2763,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLteExpression($query, $field, $params, $alias)
     {
@@ -2779,7 +2783,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLteExpression($query, $field, $params, $alias)
     {
@@ -2799,7 +2803,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGtExpression($query, $field, $params, $alias)
     {
@@ -2819,7 +2823,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGtExpression($query, $field, $params, $alias)
     {
@@ -2855,7 +2859,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGteExpression($query, $field, $params, $alias)
     {
@@ -2875,7 +2879,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGteExpression($query, $field, $params, $alias)
     {