Merge branch 'render-using-layouts' into 2.0

Author: leantony

src/Filters/AddsColumnFilters.php

@@ -85,7 +85,7 @@ protected function addDateFilter(
     {
         $filter = new GenericFilter([
             'name' => $elementId,
-            'id' => $elementId,
+            'id' => $this->createElementId($elementId),
             'enabled' => $enabled,
             'formId' => $this->getFilterFormId(),
             'class' => 'form-control grid-datepicker grid-filter ' . $elementClass,
@@ -119,7 +119,7 @@ protected function addTextFilter($enabled, $elementId, $elementClass = null): Ge
     {
         $filter = new GenericFilter([
             'name' => $elementId,
-            'id' => $elementId,
+            'id' => $this->createElementId($elementId),
             'enabled' => $enabled,
             'formId' => $this->getFilterFormId(),
             'class' => 'form-control grid-filter ' . $elementClass,
@@ -143,7 +143,7 @@ protected function addSelectFilter($enabled, $elementId, $data, $elementClass =
     {
         $filter = new GenericFilter([
             'name' => $elementId,
-            'id' => $elementId,
+            'id' => $this->createElementId($elementId),
             'enabled' => $enabled,
             'formId' => $this->getFilterFormId(),
             'type' => 'select',
@@ -152,4 +152,15 @@ protected function addSelectFilter($enabled, $elementId, $data, $elementClass =
         ]);
         return $filter;
     }
+
+    /**
+     * Create the ID for the grid filter
+     *
+     * @param $elementId
+     * @return string
+     */
+    protected function createElementId($elementId): string
+    {
+        return 'grid-filter-' . $elementId;
+    }
 }

src/Grid.php

@@ -31,7 +31,8 @@ abstract class Grid implements Htmlable, GridInterface, GridButtonsInterface, Gr
         CreatesColumns,
         ConfiguresRoutes,
         AddsColumnFilters,
-        RendersButtons;
+        RendersButtons,
+        RendersGrid;
 
     /**
      * Specify if the rows on the table should be clicked to navigate to the record
@@ -40,13 +41,6 @@ abstract class Grid implements Htmlable, GridInterface, GridButtonsInterface, Gr
      */
     protected $linkableRows = false;
 
-    /**
-     * Specify if the footer section needs to be displayed
-     *
-     * @var bool
-     */
-    protected $showFooter = false;
-
     /**
      * The id of the grid. Many grids can exist on the same page, but the ID has to be unique
      *
@@ -117,13 +111,6 @@ abstract class Grid implements Htmlable, GridInterface, GridButtonsInterface, Gr
      */
     protected $tableColumns = [];
 
-    /**
-     * Controls rendering or not, for the search form
-     *
-     * @var bool
-     */
-    protected $shouldRenderSearchForm = true;
-
     /**
      * Create the grid
      *
@@ -149,17 +136,6 @@ public function create(array $params): GridInterface
         return $this;
     }
 
-    /**
-     * Define rendering of the search form
-     *
-     * @return GridInterface
-     */
-    public function withoutSearchForm(): GridInterface
-    {
-        $this->shouldRenderSearchForm = false;
-        return $this;
-    }
-
     /**
      * Get the selected sort direction
      *
@@ -226,24 +202,6 @@ public function getName(): string
         return $this->name;
     }
 
-    /**
-     * If the grid should show a footer
-     *
-     * @return bool
-     */
-    public function shouldShowFooter(): bool
-    {
-        return $this->showFooter;
-    }
-
-    /**
-     * @param bool $showFooter
-     */
-    public function setShowFooter(bool $showFooter): void
-    {
-        $this->showFooter = $showFooter;
-    }
-
     /**
      * Transform the name of the grid, to a short, identifier
      * Useful for route param names
@@ -320,37 +278,6 @@ protected function setGridDataItems(array $result): void
         }
     }
 
-    /**
-     * Grid should render search form
-     *
-     * @return bool
-     */
-    public function shouldRenderSearchForm()
-    {
-        return $this->shouldRenderSearchForm;
-    }
-
-    /**
-     * Render the search form on the grid
-     *
-     * @return string
-     * @throws \Throwable
-     */
-    public function renderSearchForm()
-    {
-        $params = func_get_args();
-        $data = [
-            'colSize' => $this->getGridToolbarSize()[0], // size
-            'action' => $this->getSearchUrl(),
-            'id' => $this->getSearchFormId(),
-            'name' => $this->getGridSearchParam(),
-            'dataAttributes' => [],
-            'placeholder' => $this->getSearchPlaceholder(),
-        ];
-
-        return view($this->getGridSearchView(), array_merge($data, $params))->render();
-    }
-
     /**
      * Get the form id used for search
      *
@@ -445,45 +372,6 @@ public function toHtml()
         return $this->render();
     }
 
-    /**
-     * Render the grid as HTML on the user defined view
-     *
-     * @return string
-     * @throws \Throwable
-     */
-    public function render()
-    {
-        return view($this->getGridView(), $this->compactData(func_get_args()))->render();
-    }
-
-    /**
-     * Specify the data to be sent to the view
-     *
-     * @param array $params
-     * @return array
-     * @throws \Exception
-     */
-    protected function compactData($params = [])
-    {
-        $data = [
-            'grid' => $this,
-            'columns' => $this->processColumns()
-        ];
-        return array_merge($data, $this->getExtraParams($params));
-    }
-
-    /**
-     * Any extra parameters that need to be passed to the grid
-     * $params is func_get_args() passed from render
-     *
-     * @param array $params
-     * @return array
-     */
-    public function getExtraParams($params)
-    {
-        return array_merge($this->extraParams, $params);
-    }
-
     /**
      * Override this method and return a callback so that linkable rows are applied
      *
@@ -567,23 +455,4 @@ public function getHeaderClass(): string
     {
         return $this->getGridDefaultHeaderClass();
     }
-
-    /**
-     * Pass the grid on to the user defined view e.g an index page, along with any data that may be required
-     * Will dynamically switch between displaying the grid and downloading exported files
-     *
-     * @param string $viewName the view name
-     * @param array $data any extra data to be sent to the view
-     * @param string $as the variable to be sent to the view, representing the grid
-     *
-     * @return \Illuminate\Contracts\View\Factory|\Illuminate\Http\Response|\Illuminate\View\View
-     * @throws \Throwable
-     */
-    public function renderOn(string $viewName, $data = [], $as = 'grid')
-    {
-        if ($this->getRequest()->has($this->getGridExportParam())) {
-            return $this->exportHandler->export();
-        }
-        return view($viewName, array_merge($data, [$as => $this]));
-    }
 }

src/GridInterface.php

@@ -16,9 +16,9 @@ interface GridInterface
      * Create the grid
      *
      * @param array $params
-     * @return GridInterface
+     * @return $this
      */
-    public function create(array $params): GridInterface;
+    public function create(array $params): self;
 
     /**
      * Initialize grid variables

src/HasGridConfigurations.php

@@ -156,6 +156,19 @@ trait HasGridConfigurations
      */
     private $gridFooterClass;
 
+    /**
+     * @var string
+     */
+    private $gridTemplateView;
+
+    public function getGridTemplateView(): string
+    {
+        if ($this->gridTemplateView === null) {
+            $this->gridTemplateView = config('grid.templates.view', 'leantony::grid.templates.bs4-card');
+        }
+        return $this->gridTemplateView;
+    }
+
     public function getGridFooterClass(): string
     {
         if ($this->gridFooterClass === null) {