doctrine / mongodb-odm

lib/Doctrine/ODM/MongoDB/Configuration.php

Doc Comments +3 added lines, -2 removed lines

@@ -216,7 +216,7 @@ 
      * Gets a boolean flag that indicates whether proxy classes should always be regenerated
      * during each script execution.
      *
-     * @return boolean|integer
+     * @return integer
      */
     public function getAutoGenerateProxyClasses()
     {
@@ -295,7 +295,7 @@ 
      * Gets a boolean flag that indicates whether hydrator classes should always be regenerated
      * during each script execution.
      *
-     * @return boolean|integer Possible values are defined constants
+     * @return integer Possible values are defined constants
      */
     public function getAutoGenerateHydratorClasses()
     {
@@ -556,6 +556,7 @@ 
 
     /**
      * @throws MongoDBException If not is a ObjectRepository.
+     * @param string $className
      */
     public function setDefaultDocumentRepositoryClassName($className)
     {

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

Doc Comments +10 added lines

@@ -41,6 +41,7 @@ 
 
     /**
      * {@inheritDoc}
+     * @param \Doctrine\Common\Persistence\Mapping\Driver\SymfonyFileLocator $locator
      */
     public function __construct($locator, $fileExtension = self::DEFAULT_FILE_EXTENSION)
     {
@@ -312,6 +313,9 @@ 
         $class->addIndex($keys, $options);
     }
 
+    /**
+     * @param string $type
+     */
     private function addEmbedMapping(MappingClassMetadata $class, $embed, $type)
     {
         $attributes = $embed->attributes();
@@ -358,6 +362,9 @@ 
         $this->addFieldMapping($class, $mapping);
     }
 
+    /**
+     * @param string $type
+     */
     private function addReferenceMapping(MappingClassMetadata $class, $reference, $type)
     {
         $cascade = array_keys((array) $reference->cascade);
@@ -626,6 +633,9 @@ 
         return $result;
     }
 
+    /**
+     * @param string $filename
+     */
     private function validateSchema($filename)
     {
         $document = new DOMDocument();

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\Query\ReferencePrimer;

lib/Doctrine/ODM/MongoDB/Tools/DocumentGenerator.php

Doc Comments +13 added lines

@@ -774,6 +774,10 @@ 
         return implode("\n", $lines);
     }
 
+    /**
+     * @param string $type
+     * @param string $defaultValue
+     */
     private function generateDocumentStubMethod(ClassMetadata $metadata, $type, $fieldName, $typeHint = null, $defaultValue = null)
     {
         // Add/remove methods should use the singular form of the field name
@@ -958,6 +962,9 @@ 
         return implode("\n", $lines);
     }
 
+    /**
+     * @param integer $type
+     */
     private function getInheritanceTypeString($type)
     {
         switch ($type) {
@@ -975,6 +982,9 @@ 
         }
     }
 
+    /**
+     * @param integer $policy
+     */
     private function getChangeTrackingPolicyString($policy)
     {
         switch ($policy) {
@@ -992,6 +1002,9 @@ 
         }
     }
 
+    /**
+     * @param integer $type
+     */
     private function getIdGeneratorTypeString($type)
     {
         switch ($type) {

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

Doc Comments +9 added lines

@@ -88,6 +88,9 @@ 
         return parent::from($this->targetClass->getCollection());
     }
 
+    /**
+     * @param string|null $connectFromField
+     */
     public function connectFromField($connectFromField)
     {
         // No targetClass mapping - simply use field name as is
@@ -109,6 +112,9 @@ 
         return parent::connectFromField($this->getReferencedFieldName($connectFromField, $referenceMapping));
     }
 
+    /**
+     * @param string $connectToField
+     */
     public function connectToField($connectToField)
     {
         return parent::connectToField($this->convertTargetFieldName($connectToField));
@@ -168,6 +174,9 @@ 
         }
     }
 
+    /**
+     * @return string
+     */
     protected function convertTargetFieldName($fieldName)
     {
         if (self::class !== static::class) {

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

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
      */
     private $class;
 
+    /**
+     * @param string $expression
+     */
     public function __construct(Builder $builder, DocumentManager $documentManager, ClassMetadata $class, $expression = null)
     {
         $this->dm = $documentManager;

lib/Doctrine/ODM/MongoDB/DocumentManager.php

Doc Comments +2 added lines, -2 removed lines

@@ -402,7 +402,7 @@ 
      * NOTE: The persist operation always considers documents that are not yet known to
      * this DocumentManager as NEW. Do not pass detached documents to the persist operation.
      *
-     * @param object $document The instance to make managed and persistent.
+     * @param \Documents\User $document The instance to make managed and persistent.
      * @throws \InvalidArgumentException When the given $document param is not an object
      */
     public function persist($document)
@@ -627,7 +627,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/DocumentNotFoundException.php

Doc Comments +3 added lines

@@ -38,6 +38,9 @@
         parent::__construct($message, $code, $previous);
     }
 
+    /**
+     * @param string $className
+     */
     public static function documentNotFound($className, $identifier)
     {
         return new self(sprintf(

lib/Doctrine/ODM/MongoDB/EagerCursor.php

Unused Use Statements -3 removed lines

@@ -19,9 +19,6 @@
 
 namespace Doctrine\ODM\MongoDB;
 
-use Doctrine\MongoDB\CursorInterface;
-use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
-
 /**
  * EagerCursor wraps a Cursor instance and fetches all of its results upon
  * initialization.