macroparts / vortex

src/Vortex.php

Doc Comments +44 added lines, -40 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)
@@ -556,7 +556,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
      */
@@ -772,7 +772,7 @@ 
      *
      * @param $includeName
      * @param $availableIncludes
-     * @return bool|string
+     * @return false|string
      */
     private function pathForNestedInclude($includeName, $availableIncludes)
     {
@@ -904,6 +904,10 @@ 
      */
     abstract protected function initIncompleteStatement($currentUser);
 
+    /**
+     * @param string $filterString
+     * @param string $language
+     */
     private function createIncompleteStatement(
         $currentUser,
         $filterString,
@@ -1331,7 +1335,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
@@ -1445,7 +1449,7 @@ 
      * @uses getFallbackLanguage
      * @uses getRequestedLanguage
      * @param $language
-     * @return callable
+     * @return string
      */
     private function getItemLanguageGetter($language)
     {
@@ -1467,7 +1471,7 @@ 
      *
      * @param array $result
      * @param \UnserAller_Model_User $currentUser
-     * @param $language
+     * @param string $language
      * @param array $meta
      * @param int $metaOnObjectLevelOption
      * @return array
@@ -1602,9 +1606,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
@@ -1731,7 +1735,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
@@ -1905,7 +1909,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function entityIsExpression($query, $field, $params, $alias)
     {
@@ -1917,7 +1921,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityIsOrNullExpression($query, $field, $params, $alias)
     {
@@ -1933,7 +1937,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)
@@ -2003,7 +2007,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLtExpression($query, $field, $params, $alias)
     {
@@ -2023,7 +2027,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLteExpression($query, $field, $params, $alias)
     {
@@ -2043,7 +2047,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGtExpression($query, $field, $params, $alias)
     {
@@ -2063,7 +2067,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGteExpression($query, $field, $params, $alias)
     {
@@ -2274,7 +2278,7 @@ 
     }
 
     /**
-     * @param $prefix
+     * @param string $prefix
      * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
@@ -2300,7 +2304,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -2315,7 +2319,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -2327,7 +2331,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -2342,7 +2346,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -2362,7 +2366,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -2409,7 +2413,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -2433,7 +2437,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -2457,7 +2461,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -2472,7 +2476,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryIsExpression($query, $subquery, $params, $alias)
     {
@@ -2484,7 +2488,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function dateIsExpression($query, $field, $params, $alias)
     {
@@ -2496,7 +2500,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function integerIsExpression($query, $field, $params, $alias)
     {
@@ -2508,7 +2512,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringIsExpression($query, $field, $params, $alias)
     {
@@ -2557,7 +2561,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringNotExpression($query, $field, $params, $alias)
     {
@@ -2647,7 +2651,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainsExpression($query, $field, $params, $alias)
     {
@@ -2668,7 +2672,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainExpression($query, $field, $params, $alias)
     {
@@ -2680,7 +2684,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLtExpression($query, $field, $params, $alias)
     {
@@ -2700,7 +2704,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLtExpression($query, $field, $params, $alias)
     {
@@ -2720,7 +2724,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLteExpression($query, $field, $params, $alias)
     {
@@ -2740,7 +2744,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLteExpression($query, $field, $params, $alias)
     {
@@ -2760,7 +2764,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGtExpression($query, $field, $params, $alias)
     {
@@ -2780,7 +2784,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGtExpression($query, $field, $params, $alias)
     {
@@ -2816,7 +2820,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGteExpression($query, $field, $params, $alias)
     {
@@ -2836,7 +2840,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGteExpression($query, $field, $params, $alias)
     {