doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/PersistentCollection/DefaultPersistentCollectionGenerator.php

Doc Comments +5 added lines

@@ -84,6 +84,11 @@
         return $className;
     }
 
+    /**
+     * @param string $for
+     * @param string $targetFqcn
+     * @param string|false $fileName
+     */
     private function generateCollectionClass($for, $targetFqcn, $fileName)
     {
         $exploded = explode('\\', $targetFqcn);

lib/Doctrine/ODM/MongoDB/UnitOfWork.php

Doc Comments +1 added lines, -1 removed lines

@@ -2631,7 +2631,7 @@
      * @param array $data The data for the document.
      * @param array $hints Any hints to account for during reconstitution/lookup of the document.
      * @param object $document The document to be hydrated into in case of creation
-     * @return object The document instance.
+     * @return callable|null The document instance.
      * @internal Highly performance-sensitive method.
      */
     public function getOrCreateDocument($className, $data, &$hints = array(), $document = null)

lib/Doctrine/ODM/MongoDB/Aggregation/Builder.php

Doc Comments +2 added lines, -2 removed lines

@@ -383,7 +383,7 @@ 
      *
      * @see http://docs.mongodb.org/manual/reference/operator/aggregation/out/
      *
-     * @param string $collection
+     * @param string $from
      * @return Stage\Out
      */
     public function out($from)
@@ -549,7 +549,7 @@ 
     }
 
     /**
-     * @param Cursor $cursor
+     * @param \Traversable $cursor
      *
      * @return Iterator
      */

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/AbstractBucket.php

Doc Comments +3 added lines

@@ -90,6 +90,9 @@
      */
     abstract protected function getStageName();
 
+    /**
+     * @param Expr $expression
+     */
     private function convertExpression($expression)
     {
         if (is_array($expression)) {

lib/Doctrine/ODM/MongoDB/SchemaManager.php

Doc Comments +3 added lines, -3 removed lines

@@ -443,7 +443,7 @@ 
      * the unique index. Additionally, the background option is only
      * relevant to index creation and is not considered.
      *
-     * @param array|IndexInfo $mongoIndex Mongo index data.
+     * @param IndexInfo $mongoIndex Mongo index data.
      * @param array $documentIndex Document index data.
      * @return bool True if the indexes are equivalent, otherwise false.
      */
@@ -589,9 +589,9 @@ 
     }
 
     /**
-     * @param $documentName
+     * @param string $documentName
      *
-     * @return array
+     * @return string
      */
     private function runShardCollectionCommand($documentName)
     {

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/GraphLookup.php

Doc Comments +6 added lines

@@ -325,6 +325,9 @@ 
         return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function convertTargetFieldName($fieldName)
     {
         if (is_array($fieldName)) {
@@ -347,6 +350,9 @@ 
         return $this->dm->getUnitOfWork()->getDocumentPersister($class->name);
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getReferencedFieldName($fieldName, array $mapping)
     {
         if ( ! $mapping['isOwningSide']) {

lib/Doctrine/ODM/MongoDB/Aggregation/Expr.php

Doc Comments +1 added lines, -1 removed lines

@@ -1117,7 +1117,7 @@
      * @since 1.5
      * @param mixed|self $start An integer that specifies the start of the sequence. Can be any valid expression that resolves to an integer.
      * @param mixed|self $end An integer that specifies the exclusive upper limit of the sequence. Can be any valid expression that resolves to an integer.
-     * @param mixed|self $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
+     * @param integer $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
      * @return $this
      */
     public function range($start, $end, $step = 1)

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Match.php

Doc Comments +2 added lines, -2 removed lines

@@ -220,7 +220,7 @@ 
      *
      * @see Expr::geoWithin()
      * @see http://docs.mongodb.org/manual/reference/operator/geoWithin/
-     * @param array|Geometry $geometry
+     * @param Geometry $geometry
      * @return $this
      */
     public function geoWithin(Geometry $geometry)
@@ -482,7 +482,7 @@ 
      * @see Expr::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|integer $divisor
-     * @param float|integer $remainder
+     * @param integer $remainder
      * @return $this
      */
     public function mod($divisor, $remainder = 0)

lib/Doctrine/ODM/MongoDB/Aggregation/Stage/Operator.php

Doc Comments +2 added lines, -2 removed lines

@@ -411,7 +411,7 @@ 
      *
      * @see http://docs.mongodb.org/manual/meta/aggregation-quick-reference/#aggregation-expressions
      * @see Expr::expression
-     * @param mixed|Expr $value
+     * @param boolean $value
      * @return $this
      */
     public function expression($value)
@@ -1035,7 +1035,7 @@ 
      * @since 1.5
      * @param mixed|Expr $start An integer that specifies the start of the sequence. Can be any valid expression that resolves to an integer.
      * @param mixed|Expr $end An integer that specifies the exclusive upper limit of the sequence. Can be any valid expression that resolves to an integer.
-     * @param mixed|Expr $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
+     * @param integer $step Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
      * @return $this
      */
     public function range($start, $end, $step = 1)