doctrine / mongodb-odm

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

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

Doc Comments +3 added lines, -3 removed lines

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