Merge pull request #3840 from morozov/max-results-null

Fixed the QueryBuilder::setMaxResults() signature to accept NULL
doctrine · Jan 22, 2020 · 7027ec9 · 7027ec9
2 parents 4d9a08c + bf2dc10
commit 7027ec9
Show file tree

Hide file tree

Showing 2 changed files with 21 additions and 8 deletions.
diff --git a/lib/Doctrine/DBAL/Query/QueryBuilder.php b/lib/Doctrine/DBAL/Query/QueryBuilder.php
@@ -122,7 +122,7 @@ class QueryBuilder
  private $firstResult = 0;
 
  /**
- * The maximum number of results to retrieve.
+ * The maximum number of results to retrieve or NULL to retrieve all results.
  *
  * @var int|null
  */
@@ -365,7 +365,6 @@ public function setFirstResult(int $firstResult) : self
 
  /**
  * Gets the position of the first result the query object was set to retrieve (the "offset").
- * Returns NULL if {@link setFirstResult} was not applied to this QueryBuilder.
  *
  * @return int The position of the first result.
  */
@@ -377,11 +376,11 @@ public function getFirstResult() : int
  /**
  * Sets the maximum number of results to retrieve (the "limit").
  *
- * @param int $maxResults The maximum number of results to retrieve.
+ * @param int|null $maxResults The maximum number of results to retrieve or NULL to retrieve all results.
  *
  * @return $this This QueryBuilder instance.
  */
- public function setMaxResults(int $maxResults) : self
+ public function setMaxResults(?int $maxResults) : self
  {
  $this->state = self::STATE_DIRTY;
  $this->maxResults = $maxResults;
@@ -391,7 +390,7 @@ public function setMaxResults(int $maxResults) : self
 
  /**
  * Gets the maximum number of results the query object was set to retrieve (the "limit").
- * Returns NULL if {@link setMaxResults} was not applied to this query builder.
+ * Returns NULL if all results will be returned.
  *
  * @return int|null The maximum number of results.
  */

diff --git a/tests/Doctrine/Tests/DBAL/Query/QueryBuilderTest.php b/tests/Doctrine/Tests/DBAL/Query/QueryBuilderTest.php
@@ -474,13 +474,27 @@ public function testGetState() : void
  self::assertEquals($sql1, $qb->getSQL());
  }
 
- public function testSetMaxResults() : void
+ /**
+ * @dataProvider maxResultsProvider
+ */
+ public function testSetMaxResults(?int $maxResults) : void
  {
  $qb = new QueryBuilder($this->conn);
- $qb->setMaxResults(10);
+ $qb->setMaxResults($maxResults);
 
  self::assertEquals(QueryBuilder::STATE_DIRTY, $qb->getState());
- self::assertEquals(10, $qb->getMaxResults());
+ self::assertEquals($maxResults, $qb->getMaxResults());
+ }
+
+ /**
+ * @return mixed[][]
+ */
+ public static function maxResultsProvider() : iterable
+ {
+ return [
+ 'non-null' => [10],
+ 'null' => [null],
+ ];
  }
 
  public function testSetFirstResult() : void