Can change grid datamodel

 Simple refactoring, just introducing interface for datamodel. This change is without bc break. Now it is possible do to change datamodel with new method setDataModel.

Author: VojtechBuba

src/DataGrid.php

@@ -36,10 +36,12 @@
 use Ublaboo\DataGrid\Column\MultiAction;
 use Ublaboo\DataGrid\Components\DataGridPaginator\DataGridPaginator;
 use Ublaboo\DataGrid\DataSource\IDataSource;
+use Ublaboo\DataGrid\Exception\CannotChangeDataModelException;
 use Ublaboo\DataGrid\Exception\DataGridColumnNotFoundException;
 use Ublaboo\DataGrid\Exception\DataGridException;
 use Ublaboo\DataGrid\Exception\DataGridFilterNotFoundException;
 use Ublaboo\DataGrid\Exception\DataGridHasToBeAttachedToPresenterComponentException;
+use Ublaboo\DataGrid\Exception\InitializingDataModelCallbacksException;
 use Ublaboo\DataGrid\Export\Export;
 use Ublaboo\DataGrid\Export\ExportCsv;
 use Ublaboo\DataGrid\Filter\Filter;
@@ -237,7 +239,7 @@ class DataGrid extends Control
 	protected $toolbarButtons = [];
 
 	/**
-	 * @var DataModel|null
+	 * @var DataModelInterface|null
 	 */
 	protected $dataModel;
 
@@ -494,7 +496,7 @@ public function render(): void
 		/**
 		 * Check whether datagrid has set some columns, initiated data source, etc
 		 */
-		if (!($this->dataModel instanceof DataModel)) {
+		if (!($this->dataModel instanceof DataModelInterface)) {
 			throw new DataGridException('You have to set a data source first.');
 		}
 
@@ -623,7 +625,7 @@ public function setRowCallback(callable $callback): self
 	 */
 	public function setPrimaryKey(string $primaryKey): self
 	{
-		if ($this->dataModel instanceof DataModel) {
+		if ($this->dataModel instanceof DataModelInterface) {
 			throw new DataGridException('Please set datagrid primary key before setting datasource.');
 		}
 
@@ -637,14 +639,26 @@ public function setPrimaryKey(string $primaryKey): self
 	 * @param mixed $source
 	 * @return static
 	 * @throws InvalidArgumentException
+	 * @throws InitializingDataModelCallbacksException
 	 */
 	public function setDataSource($source): self
 	{
 		$this->dataModel = new DataModel($source, $this->primaryKey);
 
-		$this->dataModel->onBeforeFilter[] = [$this, 'beforeDataModelFilter'];
-		$this->dataModel->onAfterFilter[] = [$this, 'afterDataModelFilter'];
-		$this->dataModel->onAfterPaginated[] = [$this, 'afterDataModelPaginated'];
+		$this->initializeCallbacks();
+
+		return $this;
+	}
+
+
+	/**
+	 * @throws InitializingDataModelCallbacksException
+	 */
+	public function setDataModel(DataModelInterface $dataModel): self
+	{
+		$this->dataModel = $dataModel;
+
+		$this->initializeCallbacks();
 
 		return $this;
 	}
@@ -3324,4 +3338,16 @@ private function getPresenterInstance(): Presenter
 		return $this->getPresenter();
 	}
 
+
+	private function initializeCallbacks(): void
+	{
+		if ($this->dataModel === null) {
+			throw new InitializingDataModelCallbacksException();
+		}
+
+		$this->dataModel->onBeforeFilter[] = [$this, 'beforeDataModelFilter'];
+		$this->dataModel->onAfterFilter[] = [$this, 'afterDataModelFilter'];
+		$this->dataModel->onAfterPaginated[] = [$this, 'afterDataModelPaginated'];
+	}
+
 }

src/DataModel.php

@@ -31,7 +31,7 @@
  * @method onAfterFilter(IDataSource $dataSource)
  * @method onAfterPaginated(IDataSource $dataSource)
  */
-final class DataModel
+final class DataModel implements DataModelInterface
 {
 
 	use SmartObject;

src/DataModelInterface.php

@@ -0,0 +1,27 @@
+<?php declare(strict_types = 1);
+namespace Ublaboo\DataGrid;
+
+
+use Ublaboo\DataGrid\Components\DataGridPaginator\DataGridPaginator;
+use Ublaboo\DataGrid\DataSource\IDataSource;
+use Ublaboo\DataGrid\Utils\Sorting;
+
+/**
+ * @method onBeforeFilter(IDataSource $dataSource)
+ * @method onAfterFilter(IDataSource $dataSource)
+ * @method onAfterPaginated(IDataSource $dataSource)
+ */
+interface DataModelInterface
+{
+
+	public function getDataSource(): IDataSource;
+
+
+	public function filterData(?DataGridPaginator $paginatorComponent, Sorting $sorting, array $filters): iterable;
+
+
+	/**
+	 * @return mixed
+	 */
+	public function filterRow(array $condition);
+}

src/Exception/InitializingDataModelCallbacksException.php

@@ -0,0 +1,13 @@
+<?php declare(strict_types = 1);
+
+namespace Ublaboo\DataGrid\Exception;
+
+use Throwable;
+
+class InitializingDataModelCallbacksException extends DataGridException
+{
+	public function __construct(?Throwable $previous = null)
+	{
+		parent::__construct("Cannot set callbacks before data model is set.", 0, $previous);
+	}
+}

src/RestBasedDataModel.php

@@ -0,0 +1,100 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace Ublaboo\DataGrid;
+
+use Nette\SmartObject;
+use Ublaboo\DataGrid\Components\DataGridPaginator\DataGridPaginator;
+use Ublaboo\DataGrid\DataSource\IDataSource;
+use Ublaboo\DataGrid\Utils\Sorting;
+
+/**
+ * @method onBeforeFilter(IDataSource $dataSource)
+ * @method onAfterFilter(IDataSource $dataSource)
+ * @method onAfterPaginated(IDataSource $dataSource)
+ */
+final class RestBasedDataModel implements DataModelInterface
+{
+
+	use SmartObject;
+
+	/**
+	 * @var array|callable[]
+	 */
+	public $onBeforeFilter = [];
+
+	/**
+	 * @var array|callable[]
+	 */
+	public $onAfterFilter = [];
+
+	/**
+	 * @var array|callable[]
+	 */
+	public $onAfterPaginated = [];
+
+	/**
+	 * @var IDataSource
+	 */
+	private $dataSource;
+
+
+	public function __construct(IDataSource $source)
+	{
+		$this->dataSource = $source;
+	}
+
+
+	public function getDataSource(): IDataSource
+	{
+		return $this->dataSource;
+	}
+
+
+	public function filterData(
+		?DataGridPaginator $paginatorComponent,
+		Sorting $sorting,
+		array $filters
+	): iterable
+	{
+		$this->onBeforeFilter($this->dataSource);
+
+		$this->dataSource->filter($filters);
+
+		$this->onAfterFilter($this->dataSource);
+
+		/**
+		 * Paginator is optional
+		 */
+		if ($paginatorComponent !== null) {
+			$paginator = $paginatorComponent->getPaginator();
+
+			$this->dataSource->sort($sorting)->limit(
+				$paginator->getOffset(),
+				$paginator->getItemsPerPage()
+			);
+
+			$this->onAfterPaginated($this->dataSource);
+
+			$data = $this->dataSource->getData();
+			$paginator->setItemCount($this->dataSource->getCount());
+
+			return $data;
+		}
+
+		return $this->dataSource->sort($sorting)->getData();
+	}
+
+
+	/**
+	 * @return mixed
+	 */
+	public function filterRow(array $condition)
+	{
+		$this->onBeforeFilter($this->dataSource);
+		$this->onAfterFilter($this->dataSource);
+
+		return $this->dataSource->filterOne($condition)->getData();
+	}
+}