doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/Mapping/ClassMetadata.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
      *      - reflClass (ReflectionClass)
      *      - reflFields (ReflectionProperty array)
      *
-     * @return array The names of all the fields that should be serialized.
+     * @return string[] The names of all the fields that should be serialized.
      */
     public function __sleep()
     {

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

Doc Comments +3 added lines

@@ -280,6 +280,9 @@
         return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function convertTargetFieldName($fieldName)
     {
         if (is_array($fieldName)) {

lib/Doctrine/ODM/MongoDB/Mapping/Driver/XmlDriver.php

Doc Comments +1 added lines

@@ -38,6 +38,7 @@
 
     /**
      * {@inheritDoc}
+     * @param \Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator $locator
      */
     public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
     {

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

Doc Comments +3 added lines, -1 removed lines

@@ -1029,7 +1029,7 @@ 
      * @see https://docs.mongodb.com/manual/reference/operator/aggregation/range/
      * @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.
      */
     public function range($start, $end, $step = 1) : self
     {
@@ -1523,6 +1523,7 @@ 
      * Ensure that a current field has been set.
      *
      * @throws LogicException If a current field has not been set.
+     * @param string $method
      */
     private function requiresCurrentField(?string $method = null) : void
     {
@@ -1533,6 +1534,7 @@ 
 
     /**
      * @throws BadMethodCallException If there is no current switch operator.
+     * @param string $method
      */
     private function requiresSwitchStatement(?string $method = null) : void
     {

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

Doc Comments +3 added lines

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

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

Doc Comments +1 added lines, -1 removed lines

@@ -438,7 +438,7 @@
      * @see Expr::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|int $divisor
-     * @param float|int $remainder
+     * @param integer $remainder
      */
     public function mod($divisor, $remainder = 0) : self
     {

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

Doc Comments +2 added lines, -2 removed lines

@@ -376,7 +376,7 @@ 
      *
      * @see http://docs.mongodb.org/manual/meta/aggregation-quick-reference/#aggregation-expressions
      * @see Expr::expression
-     * @param mixed|Expr $value
+     * @param boolean $value
      */
     public function expression($value)
     {
@@ -944,7 +944,7 @@ 
      * @see Expr::range
      * @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.
      */
     public function range($start, $end, $step = 1) : self
     {

lib/Doctrine/ODM/MongoDB/Iterator/HydratingIterator.php

Doc Comments +1 added lines, -1 removed lines

@@ -39,7 +39,7 @@
 
     /**
      * @see http://php.net/iterator.current
-     * @return mixed
+     * @return \Doctrine\ODM\MongoDB\object|null
      */
     public function current()
     {

lib/Doctrine/ODM/MongoDB/Persisters/DocumentPersister.php

Doc Comments +5 added lines, -1 removed lines

@@ -442,6 +442,7 @@ 
      * be used to match an _id value.
      *
      * @param mixed $criteria Query criteria
+     * @param \Doctrine\Common\Proxy\Proxy $document
      * @throws LockException
      * @todo Check identity map? loadById method? Try to guess whether $criteria is the id?
      */
@@ -474,6 +475,9 @@ 
 
     /**
      * Finds documents by a set of criteria.
+     * @param string[] $sort
+     * @param integer $limit
+     * @param integer $skip
      */
     public function loadAll(array $criteria = [], ?array $sort = null, ?int $limit = null, ?int $skip = null) : Iterator
     {
@@ -583,7 +587,7 @@ 
      * @param object $result   The query result.
      * @param object $document The document object to fill, if any.
      * @param array  $hints    Hints for document creation.
-     * @return object The filled and managed document object or NULL, if the query result is empty.
+     * @return null|\Doctrine\ODM\MongoDB\object The filled and managed document object or NULL, if the query result is empty.
      */
     private function createDocument($result, ?object $document = null, array $hints = []) : ?object
     {