Move logic to makes queries without limits to the relevant adapters (#257)

* Update documentation to include info on the Exporter

* Refactor exporter and adapters to support unlimited results

* Make setStart sanitation more intuitive

* Update MongoDBAdapter.php

Make MongoAdapter behavior for length NULL consistent with other adapters

Co-authored-by: Niels Keurentjes <[email protected]>

Author: NMe84

src/Adapter/ArrayAdapter.php

@@ -72,7 +72,7 @@ public function getData(DataTableState $state): ResultSetInterface
 
         $data = iterator_to_array($this->processData($state, $this->data, $map));
 
-        $length = $state->getLength();
+        $length = $state->getLength() ?? 0;
         $page = $length > 0 ? array_slice($data, $state->getStart(), $state->getLength()) : $data;
 
         return new ArrayResultSet($page, count($this->data), count($data));

src/Adapter/Doctrine/FetchJoinORMAdapter.php

@@ -100,7 +100,7 @@ public function getResults(AdapterQuery $query): \Traversable
                 $builder->addOrderBy($column->getOrderField(), $direction);
             }
         }
-        if ($state->getLength() > 0) {
+        if (null !== $state->getLength()) {
             $builder
                 ->setFirstResult($state->getStart())
                 ->setMaxResults($state->getLength());

src/Adapter/Doctrine/ORMAdapter.php

@@ -169,7 +169,7 @@ protected function getResults(AdapterQuery $query): \Traversable
                 $builder->addOrderBy($column->getOrderField(), $direction);
             }
         }
-        if ($state->getLength() > 0) {
+        if (null !== $state->getLength()) {
             $builder
                 ->setFirstResult($state->getStart())
                 ->setMaxResults($state->getLength())

src/Adapter/Elasticsearch/ElasticaAdapter.php

@@ -80,7 +80,7 @@ protected function getResults(AdapterQuery $query): \Traversable
         $search->addIndices($this->indices);
 
         $q = $this->buildQuery($state);
-        if ($state->getLength() > 0) {
+        if (null !== $state->getLength()) {
             $q->setFrom($state->getStart())->setSize($state->getLength());
         }
         $this->applyOrdering($q, $state);

src/Adapter/MongoDB/MongoDBAdapter.php

@@ -119,8 +119,8 @@ private function buildFilter(DataTableState $state): array
     private function buildOptions(DataTableState $state): array
     {
         $options = [
-            'limit' => $state->getLength(),
-            'skip' => $state->getStart(),
+            'limit' => $state->getLength() ?? 0,
+            'skip' => $state->getLength() ? $state->getStart() : 0,
             'sort' => [],
         ];
 

src/DataTableState.php

@@ -31,8 +31,8 @@ class DataTableState
     /** @var int */
     private $start = 0;
 
-    /** @var int */
-    private $length = -1;
+    /** @var ?int */
+    private $length = null;
 
     /** @var string */
     private $globalSearch = '';
@@ -49,7 +49,7 @@ class DataTableState
     /** @var bool */
     private $isCallback = false;
 
-    /** @var string */
+    /** @var ?string */
     private $exporterName = null;
 
     /**
@@ -62,10 +62,8 @@ public function __construct(DataTable $dataTable)
 
     /**
      * Constructs a state based on the default options.
-     *
-     * @return DataTableState
      */
-    public static function fromDefaults(DataTable $dataTable)
+    public static function fromDefaults(DataTable $dataTable): self
     {
         $state = new self($dataTable);
         $state->start = (int) $dataTable->getOption('start');
@@ -81,7 +79,7 @@ public static function fromDefaults(DataTable $dataTable)
     /**
      * Loads datatables state from a parameter bag on top of any existing settings.
      */
-    public function applyParameters(ParameterBag $parameters)
+    public function applyParameters(ParameterBag $parameters): void
     {
         $this->draw = $parameters->getInt('draw');
         $this->isCallback = true;
@@ -98,7 +96,7 @@ public function applyParameters(ParameterBag $parameters)
         $this->handleSearch($parameters);
     }
 
-    private function handleOrderBy(ParameterBag $parameters)
+    private function handleOrderBy(ParameterBag $parameters): void
     {
         if ($parameters->has('order')) {
             $this->orderBy = [];
@@ -109,7 +107,7 @@ private function handleOrderBy(ParameterBag $parameters)
         }
     }
 
-    private function handleSearch(ParameterBag $parameters)
+    private function handleSearch(ParameterBag $parameters): void
     {
         foreach ($parameters->all()['columns'] ?? [] as $key => $search) {
             $column = $this->dataTable->getColumn((int) $key);
@@ -146,11 +144,13 @@ public function getStart(): int
         return $this->start;
     }
 
-    /**
-     * @return $this
-     */
-    public function setStart(int $start)
+    public function setStart(int $start): self
     {
+        if ($start < 0) {
+            @trigger_error(sprintf('Passing a negative value to the "%s::setStart()" method makes no logical sense, defaulting to 0 as the most sane default.', self::class), \E_USER_DEPRECATED);
+            $start = 0;
+        }
+
         $this->start = $start;
 
         return $this;
@@ -161,11 +161,13 @@ public function getLength(): int
         return $this->length;
     }
 
-    /**
-     * @return $this
-     */
-    public function setLength(int $length)
+    public function setLength(?int $length): self
     {
+        if ($length < 1) {
+            @trigger_error(sprintf('Calling the "%s::setLength()" method with a length less than 1 is deprecated since version 0.7 of this bundle. If you need to unrestrict the amount of records returned, pass null instead.', self::class), \E_USER_DEPRECATED);
+            $length = null;
+        }
+
         $this->length = $length;
 
         return $this;
@@ -176,20 +178,14 @@ public function getGlobalSearch(): string
         return $this->globalSearch;
     }
 
-    /**
-     * @return $this
-     */
-    public function setGlobalSearch(string $globalSearch)
+    public function setGlobalSearch(string $globalSearch): self
     {
         $this->globalSearch = $globalSearch;
 
         return $this;
     }
 
-    /**
-     * @return $this
-     */
-    public function addOrderBy(AbstractColumn $column, string $direction = DataTable::SORT_ASCENDING)
+    public function addOrderBy(AbstractColumn $column, string $direction = DataTable::SORT_ASCENDING): self
     {
         $this->orderBy[] = [$column, $direction];
 
@@ -201,9 +197,6 @@ public function getOrderBy(): array
         return $this->orderBy;
     }
 
-    /**
-     * @return $this
-     */
     public function setOrderBy(array $orderBy = []): self
     {
         $this->orderBy = $orderBy;
@@ -219,20 +212,14 @@ public function getSearchColumns(): array
         return $this->searchColumns;
     }
 
-    /**
-     * @return $this
-     */
     public function setColumnSearch(AbstractColumn $column, string $search, bool $isRegex = false): self
     {
         $this->searchColumns[$column->getName()] = ['column' => $column, 'search' => $search, 'regex' => $isRegex];
 
         return $this;
     }
 
-    /**
-     * @return string
-     */
-    public function getExporterName()
+    public function getExporterName(): string
     {
         return $this->exporterName;
     }

src/Exporter/DataTableExporterManager.php

@@ -118,7 +118,7 @@ private function getAllData(): \Iterator
     {
         $data = $this->dataTable
             ->getAdapter()
-            ->getData($this->dataTable->getState()->setStart(0)->setLength(-1))
+            ->getData($this->dataTable->getState()->setStart(0)->setLength(null))
             ->getData();
 
         foreach ($data as $row) {

tests/Fixtures/AppBundle/DataTable/Adapter/CustomORMAdapter.php

@@ -40,7 +40,7 @@ protected function getResults(AdapterQuery $query): \Traversable
                 $builder->addOrderBy($column->getOrderField(), $direction);
             }
         }
-        if ($state->getLength() > 0) {
+        if (null !== $state->getLength()) {
             $builder
                 ->setFirstResult($state->getStart())
                 ->setMaxResults($state->getLength());