macroparts / vortex

src/Vortex.php

Doc Comments +39 added lines, -29 removed lines

@@ -280,6 +280,7 @@ 
      * So when we overwrite whitelists locally they are still including all the elements from core adapters.
      *
      * @param null|string $class
+     * @param string $propertyname
      * @return array
      */
     private function getStaticPropertyOfClassMergedWithParents($class, $propertyname)
@@ -504,7 +505,7 @@ 
     /**
      * Doctrine will throw errors if a table has a multi column primary index
      * http://stackoverflow.com/questions/18968963/select-countdistinct-error-on-multiple-columns
-     * @return array
+     * @return string
      */
     protected function getPrimaryIndexCol()
     {
@@ -517,7 +518,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
      */
@@ -731,7 +732,7 @@ 
      *
      * @param $includeName
      * @param $availableIncludes
-     * @return bool|string
+     * @return false|string
      */
     private function pathForNestedInclude($includeName, $availableIncludes)
     {
@@ -831,7 +832,7 @@ 
      * @param string $alias
      * @param UnserAller_Model_User $currentUser
      * @param array $additionalParams
-     * @return array
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     protected function filterId($query, $alias, $currentUser, $additionalParams)
     {
@@ -904,6 +905,10 @@ 
      */
     protected abstract function initIncompleteStatement($currentUser);
 
+    /**
+     * @param string $filterString
+     * @param string $language
+     */
     private function createIncompleteStatement(
         $currentUser,
         $filterString,
@@ -1020,7 +1025,7 @@ 
      * @param string $orderString
      * @param int $limit
      * @param string $filterMode
-     * @return Generator
+     * @return \Generator
      */
     public function batchFindMultiple(
         $currentUser,
@@ -1419,6 +1424,9 @@ 
         }
     }
 
+    /**
+     * @param string $collectionNestingMethod
+     */
     private function applyFixesToItem(
         &$item,
         $scheduledFixes,
@@ -1511,6 +1519,7 @@ 
      * @param string $alias
      * @param UnserAller_Model_User $currentUser
      * @param array $methods
+     * @param string $field
      * @return \Doctrine\ORM\Query\Expr\Andx
      */
     protected function createConditionsForStringColumn($field, $query, $alias, $currentUser, $methods)
@@ -1769,6 +1778,7 @@ 
      * @param string $alias
      * @param UnserAller_Model_User $currentUser
      * @param array $methods
+     * @param string $prefix
      * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function createExpression($prefix, $field, $query, $alias, $currentUser, $methods)
@@ -1787,7 +1797,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function subqueryFalseExpression($query, $field, $params, $alias)
     {
@@ -1802,7 +1812,7 @@ 
      * @param string $field
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Func
      */
     private function subqueryNullExpression($query, $field, $params, $alias)
     {
@@ -1814,7 +1824,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryTrueExpression($query, $subquery, $params, $alias)
     {
@@ -1829,7 +1839,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Orx
      */
     private function subqueryAnyisExpression($query, $subquery, $params, $alias)
     {
@@ -1849,7 +1859,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryGtExpression($query, $subquery, $params, $alias)
     {
@@ -1864,7 +1874,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryGteExpression($query, $subquery, $params, $alias)
     {
@@ -1879,7 +1889,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryLteExpression($query, $subquery, $params, $alias)
     {
@@ -1894,7 +1904,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryLtExpression($query, $subquery, $params, $alias)
     {
@@ -1909,7 +1919,7 @@ 
      * @param string $subquery
      * @param array $params
      * @param string $alias
-     * @return mixed
+     * @return \Doctrine\ORM\Query\Expr\Andx
      */
     private function subqueryEqExpression($query, $subquery, $params, $alias)
     {
@@ -1924,7 +1934,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)
     {
@@ -1936,7 +1946,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)
     {
@@ -1948,7 +1958,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)
     {
@@ -1961,7 +1971,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)
@@ -2031,7 +2041,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)
     {
@@ -2121,7 +2131,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)
     {
@@ -2142,7 +2152,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)
     {
@@ -2154,7 +2164,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)
     {
@@ -2174,7 +2184,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)
     {
@@ -2194,7 +2204,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)
     {
@@ -2214,7 +2224,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)
     {
@@ -2234,7 +2244,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)
     {
@@ -2254,7 +2264,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)
     {
@@ -2290,7 +2300,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)
     {
@@ -2310,7 +2320,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)
     {