doctrine / mongodb-odm

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

Doc Comments +4 added lines

@@ -170,6 +170,10 @@
         return $this;
     }
 
+    /**
+     * @param string $fieldName
+     * @param ClassMetadata $class
+     */
     protected function prepareFieldName($fieldName, ?ClassMetadata $class = null)
     {
         if (! $class) {

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

Doc Comments +5 added lines, -4 removed lines

@@ -939,7 +939,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string|null
      */
     public function getShardKey()
     {
@@ -1039,7 +1039,7 @@ 
     /**
      * Gets the ReflectionProperties of the mapped class.
      *
-     * @return array An array of ReflectionProperty instances.
+     * @return \ReflectionProperty[] An array of ReflectionProperty instances.
      */
     public function getReflectionProperties()
     {
@@ -1352,6 +1352,7 @@ 
      * {@inheritDoc}
      *
      * Checks whether the class has a mapped association (embed or reference) with the given field name.
+     * @param string $fieldName
      */
     public function hasAssociation($fieldName)
     {
@@ -1588,7 +1589,7 @@ 
      *
      * @param string $dbFieldName
      *
-     * @return array
+     * @return string
      * @throws MappingException
      */
     public function getFieldMappingByDbFieldName($dbFieldName)
@@ -2098,7 +2099,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/Types/Type.php

Doc Comments +1 added lines, -1 removed lines

@@ -228,7 +228,7 @@
      * Get the types array map which holds all registered types and the corresponding
      * type class
      *
-     * @return array $typesMap
+     * @return string[] $typesMap
      */
     public static function getTypesMap()
     {

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/Persisters/DocumentPersister.php

Doc Comments +2 added lines, -2 removed lines

@@ -510,7 +510,7 @@ 
      * @param int    $lockMode
      * @param array  $sort     Sort array for Cursor::sort()
      * @throws LockException
-     * @return object|null The loaded and managed document instance or null if no document was found
+     * @return null|\Doctrine\ODM\MongoDB\object The loaded and managed document instance or null if no document was found
      * @todo Check identity map? loadById method? Try to guess whether $criteria is the id?
      */
     public function load($criteria, $document = null, array $hints = [], $lockMode = 0, ?array $sort = null)
@@ -670,7 +670,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, $document = null, array $hints = [])
     {

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

Doc Comments +3 added lines, -3 removed lines

@@ -1093,7 +1093,7 @@ 
      * @see Expr::mod()
      * @see http://docs.mongodb.org/manual/reference/operator/mod/
      * @param float|int $divisor
-     * @param float|int $remainder
+     * @param integer $remainder
      * @return $this
      */
     public function mod($divisor, $remainder = 0)
@@ -1257,7 +1257,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
      * @return $this
      * @throws \InvalidArgumentException If $primer is not boolean or callable.
      */
@@ -1650,7 +1650,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)
      * @return $this
      */
     public function sort($fieldName, $order = 1)