doctrine / mongodb-odm

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

Doc Comments +7 added lines

@@ -17,6 +17,7 @@ 
 
     /**
      * {@inheritDoc}
+     * @param \Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator $locator
      */
     public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
     {
@@ -219,6 +220,9 @@ 
         $class->addIndex($keys, $options);
     }
 
+    /**
+     * @param string $type
+     */
     private function addEmbedMapping(ClassMetadata $class, $embed, $type)
     {
         $attributes = $embed->attributes();
@@ -256,6 +260,9 @@ 
         $this->addFieldMapping($class, $mapping);
     }
 
+    /**
+     * @param string $type
+     */
     private function addReferenceMapping(ClassMetadata $class, $reference, $type)
     {
         $cascade = array_keys((array) $reference->cascade);

lib/Doctrine/ODM/MongoDB/SchemaManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -384,7 +384,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.
      */
@@ -525,7 +525,7 @@ 
     /**
      * @param string $documentName
      *
-     * @return array
+     * @return string
      */
     private function runShardCollectionCommand($documentName)
     {

lib/Doctrine/ODM/MongoDB/Repository/GridFSRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -13,6 +13,7 @@ 
      *
      * @param mixed    $id          File ID
      * @param resource $destination Writable Stream
+     * @return void
      */
     public function downloadToStream($id, $destination): void;
 
@@ -36,7 +37,6 @@ 
     /**
      * 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

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

Doc Comments +4 added lines, -4 removed lines

@@ -968,7 +968,7 @@ 
     }
 
     /**
-     * @return array
+     * @return string|null
      */
     public function getShardKey()
     {
@@ -1068,7 +1068,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()
     {
@@ -1619,7 +1619,7 @@ 
      *
      * @param string $dbFieldName
      *
-     * @return array
+     * @return string
      * @throws MappingException
      */
     public function getFieldMappingByDbFieldName($dbFieldName)
@@ -2136,7 +2136,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/Mapping/MappingException.php

Doc Comments +12 added lines

@@ -387,21 +387,33 @@
         return new self(sprintf("Cannot use reference priming on '%s' in class '%s'. Reference priming is only supported for inverse references", $fieldName, $className));
     }
 
+    /**
+     * @param string $fieldName
+     */
     public static function connectFromFieldMustReferenceSameDocument($fieldName)
     {
         return new self(sprintf("Cannot use field '%s' as connectFromField in a \$graphLookup stage. Reference must target the document itself.", $fieldName));
     }
 
+    /**
+     * @param string $className
+     */
     public static function repositoryMethodCanNotBeCombinedWithSkipLimitAndSort($className, $fieldName)
     {
         return new self(sprintf("'repositoryMethod' used on '%s' in class '%s' can not be combined with skip, limit or sort.", $fieldName, $className));
     }
 
+    /**
+     * @param string $className
+     */
     public static function fieldNotAllowedForGridFS($className, $fieldName)
     {
         return new self(sprintf("Field '%s' in class '%s' is not a valid field for GridFS documents. You should move it to an embedded metadata document.", $fieldName, $className));
     }
 
+    /**
+     * @param string $className
+     */
     public static function discriminatorNotAllowedForGridFS($className)
     {
         return new self(sprintf("Class '%s' cannot be discriminated because it is marked as a GridFS file"));