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/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/Mapping/Driver/XmlDriver.php

Doc Comments +7 added lines

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

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/Mapping/ClassMetadataInfo.php

Doc Comments +2 added lines, -2 removed lines

@@ -1085,7 +1085,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()
     {
@@ -1900,7 +1900,7 @@ 
      *
      * @param string $dbFieldName
      *
-     * @return array
+     * @return string
      * @throws MappingException
      */
     public function getFieldMappingByDbFieldName($dbFieldName)

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']) {