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)
@@ -557,7 +557,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
      */
@@ -773,7 +773,7 @@ 
      *
      * @param $includeName
      * @param $availableIncludes
-     * @return bool|string
+     * @return false|string
      */
     private function pathForNestedInclude($includeName, $availableIncludes)
     {
@@ -905,6 +905,10 @@ 
      */
     abstract protected function initIncompleteStatement($currentUser);
 
+    /**
+     * @param string $filterString
+     * @param string $language
+     */
     private function createIncompleteStatement(
         $currentUser,
         $filterString,
@@ -1324,7 +1328,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
@@ -1438,7 +1442,7 @@ 
      * @uses getFallbackLanguage
      * @uses getRequestedLanguage
      * @param $language
-     * @return callable
+     * @return string
      */
     private function getItemLanguageGetter($language)
     {
@@ -1460,7 +1464,7 @@ 
      *
      * @param array $result
      * @param \UnserAller_Model_User $currentUser
-     * @param $language
+     * @param string $language
      * @param array $meta
      * @param int $metaOnObjectLevelOption
      * @return array
@@ -1595,9 +1599,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
@@ -1724,7 +1728,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
@@ -1898,7 +1902,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityIsOrNullExpression($query, $field, $params, $alias)
     {
@@ -1914,7 +1918,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)
@@ -1984,7 +1988,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLtExpression($query, $field, $params, $alias)
     {
@@ -2004,7 +2008,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLteExpression($query, $field, $params, $alias)
     {
@@ -2024,7 +2028,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGtExpression($query, $field, $params, $alias)
     {
@@ -2044,7 +2048,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGteExpression($query, $field, $params, $alias)
     {
@@ -2255,7 +2259,7 @@ 
     }
 
     /**
-     * @param $prefix
+     * @param string $prefix
      * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
@@ -2281,7 +2285,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -2296,7 +2300,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -2308,7 +2312,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -2323,7 +2327,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -2343,7 +2347,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -2358,7 +2362,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGteExpression($query, $subquery, $params, $alias)
     {
@@ -2373,7 +2377,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -2388,7 +2392,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -2403,7 +2407,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -2418,7 +2422,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryIsExpression($query, $subquery, $params, $alias)
     {
@@ -2430,7 +2434,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function dateIsExpression($query, $field, $params, $alias)
     {
@@ -2442,7 +2446,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function integerIsExpression($query, $field, $params, $alias)
     {
@@ -2454,7 +2458,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringIsExpression($query, $field, $params, $alias)
     {
@@ -2503,7 +2507,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringNotExpression($query, $field, $params, $alias)
     {
@@ -2593,7 +2597,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainsExpression($query, $field, $params, $alias)
     {
@@ -2614,7 +2618,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainExpression($query, $field, $params, $alias)
     {
@@ -2626,7 +2630,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLtExpression($query, $field, $params, $alias)
     {
@@ -2646,7 +2650,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLtExpression($query, $field, $params, $alias)
     {
@@ -2666,7 +2670,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLteExpression($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 dateLteExpression($query, $field, $params, $alias)
     {
@@ -2706,7 +2710,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGtExpression($query, $field, $params, $alias)
     {
@@ -2726,7 +2730,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGtExpression($query, $field, $params, $alias)
     {
@@ -2762,7 +2766,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGteExpression($query, $field, $params, $alias)
     {
@@ -2782,7 +2786,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGteExpression($query, $field, $params, $alias)
     {