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)
@@ -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\Func
      */
     private function entityIsExpression($query, $field, $params, $alias)
     {
@@ -1910,7 +1914,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityIsOrNullExpression($query, $field, $params, $alias)
     {
@@ -1926,7 +1930,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)
@@ -1996,7 +2000,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLtExpression($query, $field, $params, $alias)
     {
@@ -2016,7 +2020,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityLteExpression($query, $field, $params, $alias)
     {
@@ -2036,7 +2040,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGtExpression($query, $field, $params, $alias)
     {
@@ -2056,7 +2060,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function entityGteExpression($query, $field, $params, $alias)
     {
@@ -2267,7 +2271,7 @@ 
     }
 
     /**
-     * @param $prefix
+     * @param string $prefix
      * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
@@ -2293,7 +2297,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -2308,7 +2312,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -2320,7 +2324,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -2335,7 +2339,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -2355,7 +2359,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -2370,7 +2374,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryGteExpression($query, $subquery, $params, $alias)
     {
@@ -2385,7 +2389,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -2400,7 +2404,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -2415,7 +2419,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -2430,7 +2434,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function subqueryIsExpression($query, $subquery, $params, $alias)
     {
@@ -2442,7 +2446,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function dateIsExpression($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 integerIsExpression($query, $field, $params, $alias)
     {
@@ -2466,7 +2470,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringIsExpression($query, $field, $params, $alias)
     {
@@ -2515,7 +2519,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Func
      */
     private function stringNotExpression($query, $field, $params, $alias)
     {
@@ -2605,7 +2609,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function stringContainsExpression($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 stringContainExpression($query, $field, $params, $alias)
     {
@@ -2638,7 +2642,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLtExpression($query, $field, $params, $alias)
     {
@@ -2658,7 +2662,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLtExpression($query, $field, $params, $alias)
     {
@@ -2678,7 +2682,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerLteExpression($query, $field, $params, $alias)
     {
@@ -2698,7 +2702,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateLteExpression($query, $field, $params, $alias)
     {
@@ -2718,7 +2722,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGtExpression($query, $field, $params, $alias)
     {
@@ -2738,7 +2742,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGtExpression($query, $field, $params, $alias)
     {
@@ -2774,7 +2778,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function integerGteExpression($query, $field, $params, $alias)
     {
@@ -2794,7 +2798,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return Query\Expr\Orx
      */
     private function dateGteExpression($query, $field, $params, $alias)
     {