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/Repository/GridFSRepository.php

Doc Comments +1 added lines, -3 removed lines

@@ -21,6 +21,7 @@ 
      *
      * @param mixed    $id          File ID
      * @param resource $destination Writable Stream
+     * @return void
      */
     public function downloadToStream($id, $destination): void;
 
@@ -35,7 +36,6 @@ 
      * Writes the contents of a readable stream to a GridFS file.
      *
      * @param resource    $source   Readable stream
-     * @param object|null $metadata
      * @return object The newly created GridFS file
      */
     public function uploadFromStream(string $filename, $source, ?UploadOptions $uploadOptions = null);
@@ -43,9 +43,7 @@ 
     /**
      * Writes the contents of a file to a GridFS file.
      *
-     * @param string      $path
      * @param string|null $filename The filename to upload the file with. If no filename is provided, the name of the source file will be used.
-     * @param object|null $metadata
      * @return object The newly created GridFS file
      */
     public function uploadFromFile(string $source, ?string $filename = null, ?UploadOptions $uploadOptions = null);

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

Doc Comments +3 added lines, -3 removed lines

@@ -983,7 +983,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
     {
@@ -1137,7 +1137,7 @@ 
      * If a custom callable is used, its signature should conform to the default
      * Closure defined in {@link ReferencePrimer::__construct()}.
      *
-     * @param bool|callable $primer
+     * @param boolean $primer
      * @throws \InvalidArgumentException If $primer is not boolean or callable.
      */
     public function prime($primer = true): self
@@ -1476,7 +1476,7 @@ 
      * field name (key) and order (value) pairs.
      *
      * @param array|string $fieldName Field name or array of field/order pairs
-     * @param int|string   $order     Field order (if one field is specified)
+     * @param integer   $order     Field order (if one field is specified)
      */
     public function sort($fieldName, $order = 1): self
     {

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

Doc Comments +1 added lines, -1 removed lines

@@ -751,7 +751,7 @@
      * @see Builder::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/Repository/DocumentRepository.php

Doc Comments -1 removed lines

@@ -153,7 +153,6 @@
      * Finds documents by a set of criteria.
      *
      * @param int|null $limit
-     * @param int|null $offset
      */
     public function findBy(array $criteria, ?array $sort = null, $limit = null, $skip = null): array
     {

lib/Doctrine/ODM/MongoDB/UnitOfWork.php

Doc Comments +1 added lines

@@ -2131,6 +2131,7 @@
 
     /**
      * Clears the UnitOfWork.
+     * @param string $documentName
      */
     public function clear(?string $documentName = null): void
     {

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

Doc Comments +3 added lines, -1 removed lines

@@ -1027,7 +1027,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
     {
@@ -1524,6 +1524,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
     {
@@ -1534,6 +1535,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/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)) {