doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/SchemaManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -582,9 +582,9 @@
     }
 
     /**
-     * @param $documentName
+     * @param string $documentName
      *
-     * @return array
+     * @return string
      */
     private function runShardCollectionCommand($documentName)
     {

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/Query/Builder.php

Unused Use Statements -1 removed lines

@@ -20,7 +20,6 @@
 namespace Doctrine\ODM\MongoDB\Query;
 
 use Doctrine\ODM\MongoDB\DocumentManager;
-use Doctrine\ODM\MongoDB\Hydrator;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo;
 
 /**

Doc Comments +2 added lines, -2 removed lines

@@ -91,7 +91,7 @@ 
      * Construct a Builder
      *
      * @param DocumentManager $dm
-     * @param string[]|string|null $documentName (optional) an array of document names, the document name, or none
+     * @param string|null $documentName (optional) an array of document names, the document name, or none
      */
     public function __construct(DocumentManager $dm, $documentName = null)
     {
@@ -144,7 +144,7 @@ 
      * If a custom callable is used, its signature should conform to the default
      * Closure defined in {@link ReferencePrimer::__construct()}.
      *
-     * @param boolean|callable $primer
+     * @param boolean $primer
      * @return $this
      * @throws \InvalidArgumentException If $primer is not boolean or callable
      */

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

Unused Use Statements -1 removed lines

@@ -22,7 +22,6 @@
 use Doctrine\Common\EventManager;
 use Doctrine\Common\Persistence\Mapping\MappingException;
 use Doctrine\MongoDB\CursorInterface;
-use Doctrine\MongoDB\EagerCursor;
 use Doctrine\ODM\MongoDB\Cursor;
 use Doctrine\ODM\MongoDB\DocumentManager;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo;

lib/Doctrine/ODM/MongoDB/DocumentManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -606,7 +606,7 @@
      * This is just a convenient shortcut for getRepository($documentName)->find($id).
      *
      * @param string $documentName
-     * @param mixed $identifier
+     * @param \MongoId $identifier
      * @param int $lockMode
      * @param int $lockVersion
      * @return object $document

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

Doc Comments +9 added lines

@@ -89,6 +89,9 @@ 
         return parent::from($this->targetClass->getCollection());
     }
 
+    /**
+     * @param string|null $connectFromField
+     */
     public function connectFromField($connectFromField)
     {
         // No targetClass mapping - simply use field name as is
@@ -110,6 +113,9 @@ 
         return parent::connectFromField($this->getReferencedFieldName($connectFromField, $referenceMapping));
     }
 
+    /**
+     * @param string $connectToField
+     */
     public function connectToField($connectToField)
     {
         return parent::connectToField($this->convertTargetFieldName($connectToField));
@@ -165,6 +171,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     protected function convertTargetFieldName($fieldName)
     {
         if (is_array($fieldName)) {

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

Doc Comments +5 added lines

@@ -149,6 +149,7 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $localField
      */
     public function localField($localField)
     {
@@ -157,12 +158,16 @@ 
 
     /**
      * {@inheritdoc}
+     * @param string $foreignField
      */
     public function foreignField($foreignField)
     {
         return parent::foreignField($this->prepareFieldName($foreignField, $this->targetClass));
     }
 
+    /**
+     * @return string
+     */
     protected function prepareFieldName($fieldName, ClassMetadata $class = null)
     {
         if ( ! $class) {