doctrine / mongodb-odm

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/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/Aggregation/Stage/Out.php

Doc Comments +1 added lines

@@ -46,6 +46,7 @@
 
     /**
      * {@inheritdoc}
+     * @param string $collection
      */
     public function out($collection)
     {

lib/Doctrine/ODM/MongoDB/SchemaManager.php

Doc Comments +1 added lines, -1 removed lines

@@ -570,7 +570,7 @@
     /**
      * @param string $documentName
      *
-     * @return array
+     * @return string
      */
     private function runShardCollectionCommand($documentName)
     {

Unused Use Statements -1 removed lines

@@ -6,7 +6,6 @@
 
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
 use Doctrine\ODM\MongoDB\Mapping\ClassMetadataFactory;
-use Doctrine\ODM\MongoDB\Mapping\MappingException;
 use MongoDB\Driver\Exception\RuntimeException;
 use MongoDB\Model\IndexInfo;
 use function array_filter;

lib/Doctrine/ODM/MongoDB/Query/Query.php

Doc Comments +1 added lines

@@ -362,6 +362,7 @@
      * query array, provided they exist and are not null.
      *
      * @param string ...$keys One or more option keys to be read
+     * @param string[] $keys
      * @return array
      */
     private function getQueryOptions(string ...$keys)

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

Doc Comments +4 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()
     {
@@ -1319,6 +1319,7 @@ 
      * {@inheritDoc}
      *
      * Checks whether the class has a mapped association (embed or reference) with the given field name.
+     * @param string $fieldName
      */
     public function hasAssociation($fieldName)
     {
@@ -1553,7 +1554,7 @@ 
      *
      * @param string $dbFieldName
      *
-     * @return array
+     * @return string
      * @throws MappingException
      */
     public function getFieldMappingByDbFieldName($dbFieldName)
@@ -2066,7 +2067,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/Driver/XmlDriver.php

Doc Comments +6 added lines

@@ -219,6 +219,9 @@ 
         $class->addIndex($keys, $options);
     }
 
+    /**
+     * @param string $type
+     */
     private function addEmbedMapping(ClassMetadata $class, $embed, $type)
     {
         $attributes = $embed->attributes();
@@ -256,6 +259,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/Aggregation/Expr.php

Doc Comments +1 added lines, -1 removed lines

@@ -1105,7 +1105,7 @@
      * @see https://docs.mongodb.com/manual/reference/operator/aggregation/range/
      * @param mixed|self $start An integer that specifies the start of the sequence. Can be any valid expression that resolves to an integer.
      * @param mixed|self $end   An integer that specifies the exclusive upper limit of the sequence. Can be any valid expression that resolves to an integer.
-     * @param mixed|self $step  Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
+     * @param integer $step  Optional. An integer that specifies the increment value. Can be any valid expression that resolves to a non-zero integer. Defaults to 1.
      * @return $this
      */
     public function range($start, $end, $step = 1)

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

Doc Comments +6 added lines

@@ -328,6 +328,9 @@ 
         return Type::convertPHPToDatabaseValue(Expr::convertExpression($expression));
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function convertTargetFieldName($fieldName)
     {
         if (is_array($fieldName)) {
@@ -349,6 +352,9 @@ 
         return $this->dm->getUnitOfWork()->getDocumentPersister($class->name);
     }
 
+    /**
+     * @param string $fieldName
+     */
     private function getReferencedFieldName($fieldName, array $mapping)
     {
         if (! $mapping['isOwningSide']) {