macroparts / vortex

src/Vortex.php

Doc Comments +34 added lines, -30 removed lines

@@ -299,7 +299,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)
@@ -546,7 +546,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
      */
@@ -762,7 +762,7 @@ 
      *
      * @param $includeName
      * @param $availableIncludes
-     * @return bool|string
+     * @return false|string
      */
     private function pathForNestedInclude($includeName, $availableIncludes)
     {
@@ -940,6 +940,10 @@ 
      */
     abstract protected function initIncompleteStatement($currentUser);
 
+    /**
+     * @param string $filterString
+     * @param string $language
+     */
     private function createIncompleteStatement(
         $currentUser,
         $filterString,
@@ -1552,7 +1556,7 @@ 
      * @param $scheduledFixes
      * @param $currentUser
      * @param $meta
-     * @param $collectionNestingMethod
+     * @param string $collectionNestingMethod
      * @param $language
      * @uses retrieveNestedCollection
      * @uses retrieveNestedCollectionAndMergeMeta
@@ -1654,7 +1658,7 @@ 
     }
 
     /**
-     * @param $field
+     * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
@@ -1987,7 +1991,7 @@ 
     }
 
     /**
-     * @param $prefix
+     * @param string $prefix
      * @param string $field
      * @param \Doctrine\ORM\QueryBuilder $query
      * @param string $alias
@@ -2013,7 +2017,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -2028,7 +2032,7 @@ 
      * @param array $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -2040,7 +2044,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -2055,7 +2059,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -2075,7 +2079,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -2090,7 +2094,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryGteExpression($query, $subquery, $params, $alias)
     {
@@ -2105,7 +2109,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -2120,7 +2124,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -2135,7 +2139,7 @@ 
      * @param array $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -2150,7 +2154,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function dateIsExpression($query, $field, $params, $alias)
     {
@@ -2162,7 +2166,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function integerIsExpression($query, $field, $params, $alias)
     {
@@ -2174,7 +2178,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function stringIsExpression($query, $field, $params, $alias)
     {
@@ -2187,7 +2191,7 @@ 
      * @param array $params
      * @param string $alias
      * @param \UnserAller_Model_User $currentUser
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Comparison
      * @throws \UnserAllerLib_Api_V4_Exception_UserRequiredButNotAuthenticated
      */
     private function integerMeExpression($query, $field, $params, $alias, $currentUser)
@@ -2257,7 +2261,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function stringNotExpression($query, $field, $params, $alias)
     {
@@ -2347,7 +2351,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function stringContainsExpression($query, $field, $params, $alias)
     {
@@ -2368,7 +2372,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function stringContainExpression($query, $field, $params, $alias)
     {
@@ -2380,7 +2384,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function dateLtExpression($query, $field, $params, $alias)
     {
@@ -2400,7 +2404,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function integerLtExpression($query, $field, $params, $alias)
     {
@@ -2420,7 +2424,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function integerLteExpression($query, $field, $params, $alias)
     {
@@ -2440,7 +2444,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function dateLteExpression($query, $field, $params, $alias)
     {
@@ -2460,7 +2464,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function dateGtExpression($query, $field, $params, $alias)
     {
@@ -2480,7 +2484,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function integerGtExpression($query, $field, $params, $alias)
     {
@@ -2516,7 +2520,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function integerGteExpression($query, $field, $params, $alias)
     {
@@ -2536,7 +2540,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function dateGteExpression($query, $field, $params, $alias)
     {