|
|
@@ -1,937 +1,921 @@
|
|
|
-<?php
|
|
|
-
|
|
|
-namespace Dcat\Admin;
|
|
|
-
|
|
|
-use Closure;
|
|
|
-use Dcat\Admin\Contracts\Repository;
|
|
|
-use Dcat\Admin\Grid\Column;
|
|
|
-use Dcat\Admin\Grid\Concerns;
|
|
|
-use Dcat\Admin\Grid\Model;
|
|
|
-use Dcat\Admin\Grid\Responsive;
|
|
|
-use Dcat\Admin\Grid\Row;
|
|
|
-use Dcat\Admin\Grid\Tools;
|
|
|
-use Dcat\Admin\Support\Helper;
|
|
|
-use Dcat\Admin\Traits\HasBuilderEvents;
|
|
|
-use Illuminate\Contracts\Support\Htmlable;
|
|
|
-use Illuminate\Contracts\Support\Renderable;
|
|
|
-use Illuminate\Database\Eloquent\Builder;
|
|
|
-use Illuminate\Support\Collection;
|
|
|
-use Illuminate\Support\Str;
|
|
|
-use Illuminate\Support\Traits\Macroable;
|
|
|
-
|
|
|
-class Grid
|
|
|
-{
|
|
|
- use HasBuilderEvents,
|
|
|
- Concerns\HasNames,
|
|
|
- Concerns\HasFilter,
|
|
|
- Concerns\HasTools,
|
|
|
- Concerns\HasActions,
|
|
|
- Concerns\HasPaginator,
|
|
|
- Concerns\HasExporter,
|
|
|
- Concerns\HasMultipleHeaders,
|
|
|
- Concerns\HasSelector,
|
|
|
- Concerns\HasQuickCreate,
|
|
|
- Concerns\HasQuickSearch,
|
|
|
- Macroable {
|
|
|
- __call as macroCall;
|
|
|
- }
|
|
|
-
|
|
|
- const CREATE_MODE_DEFAULT = 'default';
|
|
|
- const CREATE_MODE_DIALOG = 'dialog';
|
|
|
-
|
|
|
- /**
|
|
|
- * The grid data model instance.
|
|
|
- *
|
|
|
- * @var \Dcat\Admin\Grid\Model
|
|
|
- */
|
|
|
- protected $model;
|
|
|
-
|
|
|
- /**
|
|
|
- * Collection of all grid columns.
|
|
|
- *
|
|
|
- * @var \Illuminate\Support\Collection
|
|
|
- */
|
|
|
- protected $columns;
|
|
|
-
|
|
|
- /**
|
|
|
- * Collection of all data rows.
|
|
|
- *
|
|
|
- * @var \Illuminate\Support\Collection
|
|
|
- */
|
|
|
- protected $rows;
|
|
|
-
|
|
|
- /**
|
|
|
- * Rows callable fucntion.
|
|
|
- *
|
|
|
- * @var \Closure[]
|
|
|
- */
|
|
|
- protected $rowsCallback = [];
|
|
|
-
|
|
|
- /**
|
|
|
- * All column names of the grid.
|
|
|
- *
|
|
|
- * @var array
|
|
|
- */
|
|
|
- protected $columnNames = [];
|
|
|
-
|
|
|
- /**
|
|
|
- * Grid builder.
|
|
|
- *
|
|
|
- * @var \Closure
|
|
|
- */
|
|
|
- protected $builder;
|
|
|
-
|
|
|
- /**
|
|
|
- * Mark if the grid is built.
|
|
|
- *
|
|
|
- * @var bool
|
|
|
- */
|
|
|
- protected $built = false;
|
|
|
-
|
|
|
- /**
|
|
|
- * All variables in grid view.
|
|
|
- *
|
|
|
- * @var array
|
|
|
- */
|
|
|
- protected $variables = [];
|
|
|
-
|
|
|
- /**
|
|
|
- * Resource path of the grid.
|
|
|
- *
|
|
|
- * @var
|
|
|
- */
|
|
|
- protected $resourcePath;
|
|
|
-
|
|
|
- /**
|
|
|
- * Default primary key name.
|
|
|
- *
|
|
|
- * @var string
|
|
|
- */
|
|
|
- protected $keyName = 'id';
|
|
|
-
|
|
|
- /**
|
|
|
- * View for grid to render.
|
|
|
- *
|
|
|
- * @var string
|
|
|
- */
|
|
|
- protected $view = 'admin::grid.table';
|
|
|
-
|
|
|
- /**
|
|
|
- * @var Closure
|
|
|
- */
|
|
|
- protected $header;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var Closure
|
|
|
- */
|
|
|
- protected $footer;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var Closure
|
|
|
- */
|
|
|
- protected $wrapper;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var Responsive
|
|
|
- */
|
|
|
- protected $responsive;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var bool
|
|
|
- */
|
|
|
- protected $addNumberColumn = false;
|
|
|
-
|
|
|
- /**
|
|
|
- * @var string
|
|
|
- */
|
|
|
- protected $tableId = 'grid-table';
|
|
|
-
|
|
|
- /**
|
|
|
- * @var Grid\Tools\RowSelector
|
|
|
- */
|
|
|
- protected $rowSelector;
|
|
|
-
|
|
|
- /**
|
|
|
- * Options for grid.
|
|
|
- *
|
|
|
- * @var array
|
|
|
- */
|
|
|
- protected $options = [
|
|
|
- 'show_pagination' => true,
|
|
|
- 'show_filter' => true,
|
|
|
- 'show_actions' => true,
|
|
|
- 'show_quick_edit_button' => false,
|
|
|
- 'show_edit_button' => true,
|
|
|
- 'show_view_button' => true,
|
|
|
- 'show_delete_button' => true,
|
|
|
- 'show_row_selector' => true,
|
|
|
- 'show_create_button' => true,
|
|
|
- 'show_bordered' => false,
|
|
|
- 'show_toolbar' => true,
|
|
|
- 'create_mode' => self::CREATE_MODE_DEFAULT,
|
|
|
- 'dialog_form_area' => ['700px', '670px'],
|
|
|
- 'table_header_style' => 'table-header-gray',
|
|
|
- ];
|
|
|
-
|
|
|
- /**
|
|
|
- * Create a new grid instance.
|
|
|
- *
|
|
|
- * Grid constructor.
|
|
|
- *
|
|
|
- * @param Repository|\Illuminate\Database\Eloquent\Model|Builder|null $repository
|
|
|
- * @param null|\Closure $builder
|
|
|
- */
|
|
|
- public function __construct($repository = null, ?\Closure $builder = null)
|
|
|
- {
|
|
|
- if ($repository) {
|
|
|
- $this->keyName($repository->getKeyName());
|
|
|
- }
|
|
|
-
|
|
|
- $this->model = new Model(request(), $repository);
|
|
|
- $this->columns = new Collection();
|
|
|
- $this->rows = new Collection();
|
|
|
- $this->builder = $builder;
|
|
|
-
|
|
|
- $this->model()->setGrid($this);
|
|
|
-
|
|
|
- $this->setupTools();
|
|
|
- $this->setupFilter();
|
|
|
-
|
|
|
- $this->callResolving();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get table ID.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function tableId()
|
|
|
- {
|
|
|
- return $this->tableId;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get or set primary key name.
|
|
|
- *
|
|
|
- * @param string $name
|
|
|
- *
|
|
|
- * @return string|void
|
|
|
- */
|
|
|
- public function keyName(string $name = null)
|
|
|
- {
|
|
|
- if ($name === null) {
|
|
|
- return $this->keyName ?: 'id';
|
|
|
- }
|
|
|
-
|
|
|
- $this->keyName = $name;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Add column to Grid.
|
|
|
- *
|
|
|
- * @param string $name
|
|
|
- * @param string $label
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- public function column($name, $label = '')
|
|
|
- {
|
|
|
- if (strpos($name, '.') !== false) {
|
|
|
- [$relationName, $relationColumn] = explode('.', $name);
|
|
|
-
|
|
|
- $label = empty($label) ? admin_trans_field($relationColumn) : $label;
|
|
|
-
|
|
|
- $name = Str::snake($relationName).'.'.$relationColumn;
|
|
|
- }
|
|
|
-
|
|
|
- $column = $this->addColumn($name, $label);
|
|
|
-
|
|
|
- return $column;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Add number column.
|
|
|
- *
|
|
|
- * @param null|string $label
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- public function number(?string $label = null)
|
|
|
- {
|
|
|
- return $this->addColumn('#', $label ?: '#')->bold();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Batch add column to grid.
|
|
|
- *
|
|
|
- * @example
|
|
|
- * 1.$grid->columns(['name' => 'Name', 'email' => 'Email' ...]);
|
|
|
- * 2.$grid->columns('name', 'email' ...)
|
|
|
- *
|
|
|
- * @param array $columns
|
|
|
- *
|
|
|
- * @return Collection|void
|
|
|
- */
|
|
|
- public function columns($columns = null)
|
|
|
- {
|
|
|
- if ($columns === null) {
|
|
|
- return $this->columns;
|
|
|
- }
|
|
|
-
|
|
|
- if (func_num_args() == 1 && is_array($columns)) {
|
|
|
- foreach ($columns as $column => $label) {
|
|
|
- $this->column($column, $label);
|
|
|
- }
|
|
|
-
|
|
|
- return;
|
|
|
- }
|
|
|
-
|
|
|
- foreach (func_get_args() as $column) {
|
|
|
- $this->column($column);
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Add column to grid.
|
|
|
- *
|
|
|
- * @param string $field
|
|
|
- * @param string $label
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- protected function addColumn($field = '', $label = '')
|
|
|
- {
|
|
|
- $column = $this->newColumn($field, $label);
|
|
|
-
|
|
|
- $this->columns->put($field, $column);
|
|
|
-
|
|
|
- return $column;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @param string $field
|
|
|
- * @param string $label
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- public function newColumn($field = '', $label = '')
|
|
|
- {
|
|
|
- $column = new Column($field, $label);
|
|
|
- $column->setGrid($this);
|
|
|
-
|
|
|
- return $column;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get Grid model.
|
|
|
- *
|
|
|
- * @return Model
|
|
|
- */
|
|
|
- public function model()
|
|
|
- {
|
|
|
- return $this->model;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return array
|
|
|
- */
|
|
|
- public function columnNames()
|
|
|
- {
|
|
|
- return $this->columnNames;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Apply column filter to grid query.
|
|
|
- */
|
|
|
- protected function applyColumnFilter()
|
|
|
- {
|
|
|
- $this->columns->each->bindFilterQuery($this->model());
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Build the grid.
|
|
|
- *
|
|
|
- * @return void
|
|
|
- */
|
|
|
- public function build()
|
|
|
- {
|
|
|
- if ($this->built) {
|
|
|
- return;
|
|
|
- }
|
|
|
-
|
|
|
- $collection = $this->processFilter(false);
|
|
|
-
|
|
|
- $data = $collection->toArray();
|
|
|
-
|
|
|
- $this->prependRowSelectorColumn();
|
|
|
- $this->appendActionsColumn();
|
|
|
-
|
|
|
- Column::setOriginalGridModels($collection);
|
|
|
-
|
|
|
- $this->columns->map(function (Column $column) use (&$data) {
|
|
|
- $column->fill($data);
|
|
|
-
|
|
|
- $this->columnNames[] = $column->getName();
|
|
|
- });
|
|
|
-
|
|
|
- $this->buildRows($data);
|
|
|
-
|
|
|
- if ($data && $this->responsive) {
|
|
|
- $this->responsive->build();
|
|
|
- }
|
|
|
-
|
|
|
- $this->sortHeaders();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return void
|
|
|
- */
|
|
|
- protected function callBuilder()
|
|
|
- {
|
|
|
- if ($this->builder && ! $this->built) {
|
|
|
- call_user_func($this->builder, $this);
|
|
|
- }
|
|
|
-
|
|
|
- $this->built = true;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Build the grid rows.
|
|
|
- *
|
|
|
- * @param array $data
|
|
|
- *
|
|
|
- * @return void
|
|
|
- */
|
|
|
- protected function buildRows(array $data)
|
|
|
- {
|
|
|
- $this->rows = collect($data)->map(function ($model) {
|
|
|
- return new Row($this, $model);
|
|
|
- });
|
|
|
-
|
|
|
- if ($this->rowsCallback) {
|
|
|
- foreach ($this->rowsCallback as $value) {
|
|
|
- $value($this->rows);
|
|
|
- }
|
|
|
- }
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set grid row callback function.
|
|
|
- *
|
|
|
- * @param Closure $callable
|
|
|
- *
|
|
|
- * @return Collection|void
|
|
|
- */
|
|
|
- public function rows(Closure $callable = null)
|
|
|
- {
|
|
|
- if (is_null($callable)) {
|
|
|
- return $this->rows;
|
|
|
- }
|
|
|
-
|
|
|
- $this->rowsCallback[] = $callable;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get create url.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function createUrl()
|
|
|
- {
|
|
|
- $queryString = '';
|
|
|
-
|
|
|
- if ($constraints = $this->model()->getConstraints()) {
|
|
|
- $queryString = http_build_query($constraints);
|
|
|
- }
|
|
|
-
|
|
|
- return sprintf(
|
|
|
- '%s/create%s',
|
|
|
- $this->resource(),
|
|
|
- $queryString ? ('?'.$queryString) : ''
|
|
|
- );
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @param \Closure $closure
|
|
|
- *
|
|
|
- * @return Grid\Tools\RowSelector
|
|
|
- */
|
|
|
- public function rowSelector()
|
|
|
- {
|
|
|
- return $this->rowSelector ?: ($this->rowSelector = new Grid\Tools\RowSelector($this));
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Prepend checkbox column for grid.
|
|
|
- *
|
|
|
- * @return void
|
|
|
- */
|
|
|
- protected function prependRowSelectorColumn()
|
|
|
- {
|
|
|
- if (! $this->options['show_row_selector']) {
|
|
|
- return;
|
|
|
- }
|
|
|
-
|
|
|
- $rowSelector = $this->rowSelector();
|
|
|
- $keyName = $this->keyName();
|
|
|
-
|
|
|
- $column = $this->newColumn(
|
|
|
- Grid\Column::SELECT_COLUMN_NAME,
|
|
|
- $rowSelector->renderHeader()
|
|
|
- );
|
|
|
- $column->setGrid($this);
|
|
|
-
|
|
|
- $column->display(function () use ($rowSelector, $keyName) {
|
|
|
- return $rowSelector->renderColumn($this, $this->{$keyName});
|
|
|
- });
|
|
|
-
|
|
|
- $this->columns->prepend($column, Grid\Column::SELECT_COLUMN_NAME);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @param string $width
|
|
|
- * @param string $height
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function setDialogFormDimensions(string $width, string $height)
|
|
|
- {
|
|
|
- $this->options['dialog_form_area'] = [$width, $height];
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Render create button for grid.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function renderCreateButton()
|
|
|
- {
|
|
|
- if (! $this->options['show_create_button']) {
|
|
|
- return '';
|
|
|
- }
|
|
|
-
|
|
|
- return (new Tools\CreateButton($this))->render();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function withBorder()
|
|
|
- {
|
|
|
- $this->options['show_bordered'] = true;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set grid header.
|
|
|
- *
|
|
|
- * @param Closure|string|Renderable $content
|
|
|
- *
|
|
|
- * @return $this|Closure
|
|
|
- */
|
|
|
- public function header($content = null)
|
|
|
- {
|
|
|
- if (! $content) {
|
|
|
- return $this->header;
|
|
|
- }
|
|
|
-
|
|
|
- $this->header = $content;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Render grid header.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function renderHeader()
|
|
|
- {
|
|
|
- if (! $this->header) {
|
|
|
- return '';
|
|
|
- }
|
|
|
-
|
|
|
- $content = Helper::render($this->header, [$this->processFilter(false)]);
|
|
|
-
|
|
|
- if (empty($content)) {
|
|
|
- return '';
|
|
|
- }
|
|
|
-
|
|
|
- if ($content instanceof Renderable) {
|
|
|
- $content = $content->render();
|
|
|
- }
|
|
|
-
|
|
|
- if ($content instanceof Htmlable) {
|
|
|
- $content = $content->toHtml();
|
|
|
- }
|
|
|
-
|
|
|
- return <<<HTML
|
|
|
-<div class="box-header clearfix" style="border-top:1px solid #ebeff2">{$content}</div>
|
|
|
-HTML;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set grid footer.
|
|
|
- *
|
|
|
- * @param Closure|string|Renderable $content
|
|
|
- *
|
|
|
- * @return $this|Closure
|
|
|
- */
|
|
|
- public function footer($content = null)
|
|
|
- {
|
|
|
- if (! $content) {
|
|
|
- return $this->footer;
|
|
|
- }
|
|
|
-
|
|
|
- $this->footer = $content;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Render grid footer.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function renderFooter()
|
|
|
- {
|
|
|
- if (! $this->footer) {
|
|
|
- return '';
|
|
|
- }
|
|
|
-
|
|
|
- $content = Helper::render($this->footer, [$this->processFilter(false)]);
|
|
|
-
|
|
|
- if (empty($content)) {
|
|
|
- return '';
|
|
|
- }
|
|
|
-
|
|
|
- if ($content instanceof Renderable) {
|
|
|
- $content = $content->render();
|
|
|
- }
|
|
|
-
|
|
|
- if ($content instanceof Htmlable) {
|
|
|
- $content = $content->toHtml();
|
|
|
- }
|
|
|
-
|
|
|
- return <<<HTML
|
|
|
- <div class="box-footer clearfix">{$content}</div>
|
|
|
-HTML;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get or set option for grid.
|
|
|
- *
|
|
|
- * @param string $key
|
|
|
- * @param mixed $value
|
|
|
- *
|
|
|
- * @return $this|mixed
|
|
|
- */
|
|
|
- public function option($key, $value = null)
|
|
|
- {
|
|
|
- if (is_null($value)) {
|
|
|
- return $this->options[$key];
|
|
|
- }
|
|
|
-
|
|
|
- $this->options[$key] = $value;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Disable row selector.
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function disableRowSelector(bool $disable = true)
|
|
|
- {
|
|
|
- $this->tools->disableBatchActions($disable);
|
|
|
-
|
|
|
- return $this->option('show_row_selector', ! $disable);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Show row selector.
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function showRowSelector(bool $val = true)
|
|
|
- {
|
|
|
- return $this->disableRowSelector(! $val);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Remove create button on grid.
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function disableCreateButton(bool $disable = true)
|
|
|
- {
|
|
|
- return $this->option('show_create_button', ! $disable);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Show create button.
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function showCreateButton(bool $val = true)
|
|
|
- {
|
|
|
- return $this->disableCreateButton(! $val);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * If allow creation.
|
|
|
- *
|
|
|
- * @return bool
|
|
|
- */
|
|
|
- public function allowCreateButton()
|
|
|
- {
|
|
|
- return $this->options['show_create_button'];
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @param string $mode
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function createMode(string $mode)
|
|
|
- {
|
|
|
- return $this->option('create_mode', $mode);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function enableDialogCreate()
|
|
|
- {
|
|
|
- return $this->createMode(self::CREATE_MODE_DIALOG);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get or set resource path.
|
|
|
- *
|
|
|
- * @param string $path
|
|
|
- *
|
|
|
- * @return $this|string
|
|
|
- */
|
|
|
- public function resource(string $path = null)
|
|
|
- {
|
|
|
- if ($path === null) {
|
|
|
- return $this->resourcePath ?: (
|
|
|
- $this->resourcePath = url(app('request')->getPathInfo())
|
|
|
- );
|
|
|
- }
|
|
|
-
|
|
|
- if (! empty($path)) {
|
|
|
- $this->resourcePath = admin_url($path);
|
|
|
- }
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Create a grid instance.
|
|
|
- *
|
|
|
- * @param mixed ...$params
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public static function make(...$params)
|
|
|
- {
|
|
|
- return new static(...$params);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Enable responsive tables.
|
|
|
- *
|
|
|
- * @see https://github.com/nadangergeo/RWD-Table-Patterns
|
|
|
- *
|
|
|
- * @return Responsive
|
|
|
- */
|
|
|
- public function responsive()
|
|
|
- {
|
|
|
- if (! $this->responsive) {
|
|
|
- $this->responsive = new Responsive($this);
|
|
|
- }
|
|
|
-
|
|
|
- return $this->responsive;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return bool
|
|
|
- */
|
|
|
- public function allowResponsive()
|
|
|
- {
|
|
|
- return $this->responsive ? true : false;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @param Closure $closure
|
|
|
- *
|
|
|
- * @return $this;
|
|
|
- */
|
|
|
- public function wrap(\Closure $closure)
|
|
|
- {
|
|
|
- $this->wrapper = $closure;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return bool
|
|
|
- */
|
|
|
- public function hasWrapper()
|
|
|
- {
|
|
|
- return $this->wrapper ? true : false;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Add variables to grid view.
|
|
|
- *
|
|
|
- * @param array $variables
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function with($variables = [])
|
|
|
- {
|
|
|
- $this->variables = $variables;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get all variables will used in grid view.
|
|
|
- *
|
|
|
- * @return array
|
|
|
- */
|
|
|
- protected function variables()
|
|
|
- {
|
|
|
- $this->variables['grid'] = $this;
|
|
|
- $this->variables['tableId'] = $this->tableId();
|
|
|
-
|
|
|
- return $this->variables;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set a view to render.
|
|
|
- *
|
|
|
- * @param string $view
|
|
|
- * @param array $variables
|
|
|
- */
|
|
|
- public function view($view, $variables = [])
|
|
|
- {
|
|
|
- if (! empty($variables)) {
|
|
|
- $this->with($variables);
|
|
|
- }
|
|
|
-
|
|
|
- $this->view = $view;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set grid title.
|
|
|
- *
|
|
|
- * @param string $title
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function title($title)
|
|
|
- {
|
|
|
- $this->variables['title'] = $title;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set grid description.
|
|
|
- *
|
|
|
- * @param string $description
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function description($description)
|
|
|
- {
|
|
|
- $this->variables['description'] = $description;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Set resource path for grid.
|
|
|
- *
|
|
|
- * @param string $path
|
|
|
- *
|
|
|
- * @return $this
|
|
|
- */
|
|
|
- public function setResource($path)
|
|
|
- {
|
|
|
- $this->resourcePath = $path;
|
|
|
-
|
|
|
- return $this;
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Get the string contents of the grid view.
|
|
|
- *
|
|
|
- * @return string
|
|
|
- */
|
|
|
- public function render()
|
|
|
- {
|
|
|
- $this->handleExportRequest();
|
|
|
-
|
|
|
- try {
|
|
|
- $this->callComposing();
|
|
|
-
|
|
|
- $this->build();
|
|
|
- } catch (\Throwable $e) {
|
|
|
- return Admin::makeExceptionHandler()->renderException($e);
|
|
|
- }
|
|
|
-
|
|
|
- return $this->doWrap();
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * @return string
|
|
|
- */
|
|
|
- protected function doWrap()
|
|
|
- {
|
|
|
- $view = view($this->view, $this->variables());
|
|
|
-
|
|
|
- if (! $wrapper = $this->wrapper) {
|
|
|
- return $view->render();
|
|
|
- }
|
|
|
-
|
|
|
- return $wrapper($view);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Add column to grid.
|
|
|
- *
|
|
|
- * @param string $name
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- public function __get($name)
|
|
|
- {
|
|
|
- return $this->addColumn($name);
|
|
|
- }
|
|
|
-
|
|
|
- /**
|
|
|
- * Dynamically add columns to the grid view.
|
|
|
- *
|
|
|
- * @param $method
|
|
|
- * @param $arguments
|
|
|
- *
|
|
|
- * @return Column
|
|
|
- */
|
|
|
- public function __call($method, $arguments)
|
|
|
- {
|
|
|
- if (static::hasMacro($method)) {
|
|
|
- return $this->macroCall($method, $arguments);
|
|
|
- }
|
|
|
-
|
|
|
- return $this->addColumn($method, $arguments[0] ?? null);
|
|
|
- }
|
|
|
-}
|
|
|
+<?php
|
|
|
+
|
|
|
+namespace Dcat\Admin;
|
|
|
+
|
|
|
+use Closure;
|
|
|
+use Dcat\Admin\Contracts\Repository;
|
|
|
+use Dcat\Admin\Grid\Column;
|
|
|
+use Dcat\Admin\Grid\Concerns;
|
|
|
+use Dcat\Admin\Grid\Model;
|
|
|
+use Dcat\Admin\Grid\Responsive;
|
|
|
+use Dcat\Admin\Grid\Row;
|
|
|
+use Dcat\Admin\Grid\Tools;
|
|
|
+use Dcat\Admin\Support\Helper;
|
|
|
+use Dcat\Admin\Traits\HasBuilderEvents;
|
|
|
+use Illuminate\Contracts\Support\Htmlable;
|
|
|
+use Illuminate\Contracts\Support\Renderable;
|
|
|
+use Illuminate\Database\Eloquent\Builder;
|
|
|
+use Illuminate\Support\Collection;
|
|
|
+use Illuminate\Support\Str;
|
|
|
+use Illuminate\Support\Traits\Macroable;
|
|
|
+
|
|
|
+class Grid
|
|
|
+{
|
|
|
+ use HasBuilderEvents,
|
|
|
+ Concerns\HasNames,
|
|
|
+ Concerns\HasFilter,
|
|
|
+ Concerns\HasTools,
|
|
|
+ Concerns\HasActions,
|
|
|
+ Concerns\HasPaginator,
|
|
|
+ Concerns\HasExporter,
|
|
|
+ Concerns\HasMultipleHeaders,
|
|
|
+ Concerns\HasSelector,
|
|
|
+ Concerns\HasQuickCreate,
|
|
|
+ Concerns\HasQuickSearch,
|
|
|
+ Macroable {
|
|
|
+ __call as macroCall;
|
|
|
+ }
|
|
|
+
|
|
|
+ const CREATE_MODE_DEFAULT = 'default';
|
|
|
+ const CREATE_MODE_DIALOG = 'dialog';
|
|
|
+
|
|
|
+ /**
|
|
|
+ * The grid data model instance.
|
|
|
+ *
|
|
|
+ * @var \Dcat\Admin\Grid\Model
|
|
|
+ */
|
|
|
+ protected $model;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Collection of all grid columns.
|
|
|
+ *
|
|
|
+ * @var \Illuminate\Support\Collection
|
|
|
+ */
|
|
|
+ protected $columns;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Collection of all data rows.
|
|
|
+ *
|
|
|
+ * @var \Illuminate\Support\Collection
|
|
|
+ */
|
|
|
+ protected $rows;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Rows callable fucntion.
|
|
|
+ *
|
|
|
+ * @var \Closure[]
|
|
|
+ */
|
|
|
+ protected $rowsCallback = [];
|
|
|
+
|
|
|
+ /**
|
|
|
+ * All column names of the grid.
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ protected $columnNames = [];
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Grid builder.
|
|
|
+ *
|
|
|
+ * @var \Closure
|
|
|
+ */
|
|
|
+ protected $builder;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Mark if the grid is built.
|
|
|
+ *
|
|
|
+ * @var bool
|
|
|
+ */
|
|
|
+ protected $built = false;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * All variables in grid view.
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ protected $variables = [];
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Resource path of the grid.
|
|
|
+ *
|
|
|
+ * @var
|
|
|
+ */
|
|
|
+ protected $resourcePath;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Default primary key name.
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ protected $keyName = 'id';
|
|
|
+
|
|
|
+ /**
|
|
|
+ * View for grid to render.
|
|
|
+ *
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ protected $view = 'admin::grid.table';
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var Closure
|
|
|
+ */
|
|
|
+ protected $header;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var Closure
|
|
|
+ */
|
|
|
+ protected $footer;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var Closure
|
|
|
+ */
|
|
|
+ protected $wrapper;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var Responsive
|
|
|
+ */
|
|
|
+ protected $responsive;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var bool
|
|
|
+ */
|
|
|
+ protected $addNumberColumn = false;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var string
|
|
|
+ */
|
|
|
+ protected $tableId = 'grid-table';
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @var Grid\Tools\RowSelector
|
|
|
+ */
|
|
|
+ protected $rowSelector;
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Options for grid.
|
|
|
+ *
|
|
|
+ * @var array
|
|
|
+ */
|
|
|
+ protected $options = [
|
|
|
+ 'show_pagination' => true,
|
|
|
+ 'show_filter' => true,
|
|
|
+ 'show_actions' => true,
|
|
|
+ 'show_quick_edit_button' => false,
|
|
|
+ 'show_edit_button' => true,
|
|
|
+ 'show_view_button' => true,
|
|
|
+ 'show_delete_button' => true,
|
|
|
+ 'show_row_selector' => true,
|
|
|
+ 'show_create_button' => true,
|
|
|
+ 'show_bordered' => false,
|
|
|
+ 'show_toolbar' => true,
|
|
|
+ 'create_mode' => self::CREATE_MODE_DEFAULT,
|
|
|
+ 'dialog_form_area' => ['700px', '670px'],
|
|
|
+ 'table_header_style' => 'table-header-gray',
|
|
|
+ ];
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Create a new grid instance.
|
|
|
+ *
|
|
|
+ * Grid constructor.
|
|
|
+ *
|
|
|
+ * @param Repository|\Illuminate\Database\Eloquent\Model|Builder|null $repository
|
|
|
+ * @param null|\Closure $builder
|
|
|
+ */
|
|
|
+ public function __construct($repository = null, ?\Closure $builder = null)
|
|
|
+ {
|
|
|
+ if ($repository) {
|
|
|
+ $this->keyName($repository->getKeyName());
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->model = new Model(request(), $repository);
|
|
|
+ $this->columns = new Collection();
|
|
|
+ $this->rows = new Collection();
|
|
|
+ $this->builder = $builder;
|
|
|
+
|
|
|
+ $this->model()->setGrid($this);
|
|
|
+
|
|
|
+ $this->setupTools();
|
|
|
+ $this->setupFilter();
|
|
|
+
|
|
|
+ $this->callResolving();
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get table ID.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function tableId()
|
|
|
+ {
|
|
|
+ return $this->tableId;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get or set primary key name.
|
|
|
+ *
|
|
|
+ * @param string $name
|
|
|
+ *
|
|
|
+ * @return string|void
|
|
|
+ */
|
|
|
+ public function keyName(string $name = null)
|
|
|
+ {
|
|
|
+ if ($name === null) {
|
|
|
+ return $this->keyName ?: 'id';
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->keyName = $name;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Add column to Grid.
|
|
|
+ *
|
|
|
+ * @param string $name
|
|
|
+ * @param string $label
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ public function column($name, $label = '')
|
|
|
+ {
|
|
|
+ if (strpos($name, '.') !== false) {
|
|
|
+ [$relationName, $relationColumn] = explode('.', $name);
|
|
|
+
|
|
|
+ $label = empty($label) ? admin_trans_field($relationColumn) : $label;
|
|
|
+
|
|
|
+ $name = Str::snake($relationName).'.'.$relationColumn;
|
|
|
+ }
|
|
|
+
|
|
|
+ $column = $this->addColumn($name, $label);
|
|
|
+
|
|
|
+ return $column;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Add number column.
|
|
|
+ *
|
|
|
+ * @param null|string $label
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ public function number(?string $label = null)
|
|
|
+ {
|
|
|
+ return $this->addColumn('#', $label ?: '#')->bold();
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Batch add column to grid.
|
|
|
+ *
|
|
|
+ * @example
|
|
|
+ * 1.$grid->columns(['name' => 'Name', 'email' => 'Email' ...]);
|
|
|
+ * 2.$grid->columns('name', 'email' ...)
|
|
|
+ *
|
|
|
+ * @param array $columns
|
|
|
+ *
|
|
|
+ * @return Collection|void
|
|
|
+ */
|
|
|
+ public function columns($columns = null)
|
|
|
+ {
|
|
|
+ if ($columns === null) {
|
|
|
+ return $this->columns;
|
|
|
+ }
|
|
|
+
|
|
|
+ if (func_num_args() == 1 && is_array($columns)) {
|
|
|
+ foreach ($columns as $column => $label) {
|
|
|
+ $this->column($column, $label);
|
|
|
+ }
|
|
|
+
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ foreach (func_get_args() as $column) {
|
|
|
+ $this->column($column);
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Add column to grid.
|
|
|
+ *
|
|
|
+ * @param string $field
|
|
|
+ * @param string $label
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ protected function addColumn($field = '', $label = '')
|
|
|
+ {
|
|
|
+ $column = $this->newColumn($field, $label);
|
|
|
+
|
|
|
+ $this->columns->put($field, $column);
|
|
|
+
|
|
|
+ return $column;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @param string $field
|
|
|
+ * @param string $label
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ public function newColumn($field = '', $label = '')
|
|
|
+ {
|
|
|
+ $column = new Column($field, $label);
|
|
|
+ $column->setGrid($this);
|
|
|
+
|
|
|
+ return $column;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get Grid model.
|
|
|
+ *
|
|
|
+ * @return Model
|
|
|
+ */
|
|
|
+ public function model()
|
|
|
+ {
|
|
|
+ return $this->model;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return array
|
|
|
+ */
|
|
|
+ public function columnNames()
|
|
|
+ {
|
|
|
+ return $this->columnNames;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Apply column filter to grid query.
|
|
|
+ */
|
|
|
+ protected function applyColumnFilter()
|
|
|
+ {
|
|
|
+ $this->columns->each->bindFilterQuery($this->model());
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Build the grid.
|
|
|
+ *
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ public function build()
|
|
|
+ {
|
|
|
+ if ($this->built) {
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ $collection = $this->processFilter(false);
|
|
|
+
|
|
|
+ $data = $collection->toArray();
|
|
|
+
|
|
|
+ $this->prependRowSelectorColumn();
|
|
|
+ $this->appendActionsColumn();
|
|
|
+
|
|
|
+ Column::setOriginalGridModels($collection);
|
|
|
+
|
|
|
+ $this->columns->map(function (Column $column) use (&$data) {
|
|
|
+ $column->fill($data);
|
|
|
+
|
|
|
+ $this->columnNames[] = $column->getName();
|
|
|
+ });
|
|
|
+
|
|
|
+ $this->buildRows($data);
|
|
|
+
|
|
|
+ if ($data && $this->responsive) {
|
|
|
+ $this->responsive->build();
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->sortHeaders();
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ protected function callBuilder()
|
|
|
+ {
|
|
|
+ if ($this->builder && ! $this->built) {
|
|
|
+ call_user_func($this->builder, $this);
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->built = true;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Build the grid rows.
|
|
|
+ *
|
|
|
+ * @param array $data
|
|
|
+ *
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ protected function buildRows(array $data)
|
|
|
+ {
|
|
|
+ $this->rows = collect($data)->map(function ($model) {
|
|
|
+ return new Row($this, $model);
|
|
|
+ });
|
|
|
+
|
|
|
+ if ($this->rowsCallback) {
|
|
|
+ foreach ($this->rowsCallback as $value) {
|
|
|
+ $value($this->rows);
|
|
|
+ }
|
|
|
+ }
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set grid row callback function.
|
|
|
+ *
|
|
|
+ * @param Closure $callable
|
|
|
+ *
|
|
|
+ * @return Collection|void
|
|
|
+ */
|
|
|
+ public function rows(Closure $callable = null)
|
|
|
+ {
|
|
|
+ if (is_null($callable)) {
|
|
|
+ return $this->rows;
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->rowsCallback[] = $callable;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get create url.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function createUrl()
|
|
|
+ {
|
|
|
+ $queryString = '';
|
|
|
+
|
|
|
+ if ($constraints = $this->model()->getConstraints()) {
|
|
|
+ $queryString = http_build_query($constraints);
|
|
|
+ }
|
|
|
+
|
|
|
+ return sprintf(
|
|
|
+ '%s/create%s',
|
|
|
+ $this->resource(),
|
|
|
+ $queryString ? ('?'.$queryString) : ''
|
|
|
+ );
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @param \Closure $closure
|
|
|
+ *
|
|
|
+ * @return Grid\Tools\RowSelector
|
|
|
+ */
|
|
|
+ public function rowSelector()
|
|
|
+ {
|
|
|
+ return $this->rowSelector ?: ($this->rowSelector = new Grid\Tools\RowSelector($this));
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Prepend checkbox column for grid.
|
|
|
+ *
|
|
|
+ * @return void
|
|
|
+ */
|
|
|
+ protected function prependRowSelectorColumn()
|
|
|
+ {
|
|
|
+ if (! $this->options['show_row_selector']) {
|
|
|
+ return;
|
|
|
+ }
|
|
|
+
|
|
|
+ $rowSelector = $this->rowSelector();
|
|
|
+ $keyName = $this->keyName();
|
|
|
+
|
|
|
+ $column = $this->newColumn(
|
|
|
+ Grid\Column::SELECT_COLUMN_NAME,
|
|
|
+ $rowSelector->renderHeader()
|
|
|
+ );
|
|
|
+ $column->setGrid($this);
|
|
|
+
|
|
|
+ $column->display(function () use ($rowSelector, $keyName) {
|
|
|
+ return $rowSelector->renderColumn($this, $this->{$keyName});
|
|
|
+ });
|
|
|
+
|
|
|
+ $this->columns->prepend($column, Grid\Column::SELECT_COLUMN_NAME);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @param string $width
|
|
|
+ * @param string $height
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function setDialogFormDimensions(string $width, string $height)
|
|
|
+ {
|
|
|
+ $this->options['dialog_form_area'] = [$width, $height];
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Render create button for grid.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function renderCreateButton()
|
|
|
+ {
|
|
|
+ if (! $this->options['show_create_button']) {
|
|
|
+ return '';
|
|
|
+ }
|
|
|
+
|
|
|
+ return (new Tools\CreateButton($this))->render();
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function withBorder()
|
|
|
+ {
|
|
|
+ $this->options['show_bordered'] = true;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set grid header.
|
|
|
+ *
|
|
|
+ * @param Closure|string|Renderable $content
|
|
|
+ *
|
|
|
+ * @return $this|Closure
|
|
|
+ */
|
|
|
+ public function header($content = null)
|
|
|
+ {
|
|
|
+ if (! $content) {
|
|
|
+ return $this->header;
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->header = $content;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Render grid header.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function renderHeader()
|
|
|
+ {
|
|
|
+ if (! $this->header) {
|
|
|
+ return '';
|
|
|
+ }
|
|
|
+
|
|
|
+ $content = Helper::render($this->header, [$this->processFilter(false)]);
|
|
|
+
|
|
|
+ if (empty($content)) {
|
|
|
+ return '';
|
|
|
+ }
|
|
|
+
|
|
|
+ return <<<HTML
|
|
|
+<div class="box-header clearfix" style="border-top:1px solid #ebeff2">{$content}</div>
|
|
|
+HTML;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set grid footer.
|
|
|
+ *
|
|
|
+ * @param Closure|string|Renderable $content
|
|
|
+ *
|
|
|
+ * @return $this|Closure
|
|
|
+ */
|
|
|
+ public function footer($content = null)
|
|
|
+ {
|
|
|
+ if (! $content) {
|
|
|
+ return $this->footer;
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->footer = $content;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Render grid footer.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function renderFooter()
|
|
|
+ {
|
|
|
+ if (! $this->footer) {
|
|
|
+ return '';
|
|
|
+ }
|
|
|
+
|
|
|
+ $content = Helper::render($this->footer, [$this->processFilter(false)]);
|
|
|
+
|
|
|
+ if (empty($content)) {
|
|
|
+ return '';
|
|
|
+ }
|
|
|
+
|
|
|
+ return <<<HTML
|
|
|
+<div class="box-footer clearfix">{$content}</div>
|
|
|
+HTML;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get or set option for grid.
|
|
|
+ *
|
|
|
+ * @param string $key
|
|
|
+ * @param mixed $value
|
|
|
+ *
|
|
|
+ * @return $this|mixed
|
|
|
+ */
|
|
|
+ public function option($key, $value = null)
|
|
|
+ {
|
|
|
+ if (is_null($value)) {
|
|
|
+ return $this->options[$key];
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->options[$key] = $value;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Disable row selector.
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function disableRowSelector(bool $disable = true)
|
|
|
+ {
|
|
|
+ $this->tools->disableBatchActions($disable);
|
|
|
+
|
|
|
+ return $this->option('show_row_selector', ! $disable);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Show row selector.
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function showRowSelector(bool $val = true)
|
|
|
+ {
|
|
|
+ return $this->disableRowSelector(! $val);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Remove create button on grid.
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function disableCreateButton(bool $disable = true)
|
|
|
+ {
|
|
|
+ return $this->option('show_create_button', ! $disable);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Show create button.
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function showCreateButton(bool $val = true)
|
|
|
+ {
|
|
|
+ return $this->disableCreateButton(! $val);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * If allow creation.
|
|
|
+ *
|
|
|
+ * @return bool
|
|
|
+ */
|
|
|
+ public function allowCreateButton()
|
|
|
+ {
|
|
|
+ return $this->options['show_create_button'];
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @param string $mode
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function createMode(string $mode)
|
|
|
+ {
|
|
|
+ return $this->option('create_mode', $mode);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function enableDialogCreate()
|
|
|
+ {
|
|
|
+ return $this->createMode(self::CREATE_MODE_DIALOG);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get or set resource path.
|
|
|
+ *
|
|
|
+ * @param string $path
|
|
|
+ *
|
|
|
+ * @return $this|string
|
|
|
+ */
|
|
|
+ public function resource(string $path = null)
|
|
|
+ {
|
|
|
+ if ($path === null) {
|
|
|
+ return $this->resourcePath ?: (
|
|
|
+ $this->resourcePath = url(app('request')->getPathInfo())
|
|
|
+ );
|
|
|
+ }
|
|
|
+
|
|
|
+ if (! empty($path)) {
|
|
|
+ $this->resourcePath = admin_url($path);
|
|
|
+ }
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Create a grid instance.
|
|
|
+ *
|
|
|
+ * @param mixed ...$params
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public static function make(...$params)
|
|
|
+ {
|
|
|
+ return new static(...$params);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Enable responsive tables.
|
|
|
+ *
|
|
|
+ * @see https://github.com/nadangergeo/RWD-Table-Patterns
|
|
|
+ *
|
|
|
+ * @return Responsive
|
|
|
+ */
|
|
|
+ public function responsive()
|
|
|
+ {
|
|
|
+ if (! $this->responsive) {
|
|
|
+ $this->responsive = new Responsive($this);
|
|
|
+ }
|
|
|
+
|
|
|
+ return $this->responsive;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return bool
|
|
|
+ */
|
|
|
+ public function allowResponsive()
|
|
|
+ {
|
|
|
+ return $this->responsive ? true : false;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @param Closure $closure
|
|
|
+ *
|
|
|
+ * @return $this;
|
|
|
+ */
|
|
|
+ public function wrap(\Closure $closure)
|
|
|
+ {
|
|
|
+ $this->wrapper = $closure;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return bool
|
|
|
+ */
|
|
|
+ public function hasWrapper()
|
|
|
+ {
|
|
|
+ return $this->wrapper ? true : false;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Add variables to grid view.
|
|
|
+ *
|
|
|
+ * @param array $variables
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function with($variables = [])
|
|
|
+ {
|
|
|
+ $this->variables = $variables;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get all variables will used in grid view.
|
|
|
+ *
|
|
|
+ * @return array
|
|
|
+ */
|
|
|
+ protected function variables()
|
|
|
+ {
|
|
|
+ $this->variables['grid'] = $this;
|
|
|
+ $this->variables['tableId'] = $this->tableId();
|
|
|
+
|
|
|
+ return $this->variables;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set a view to render.
|
|
|
+ *
|
|
|
+ * @param string $view
|
|
|
+ * @param array $variables
|
|
|
+ */
|
|
|
+ public function view($view, $variables = [])
|
|
|
+ {
|
|
|
+ if (! empty($variables)) {
|
|
|
+ $this->with($variables);
|
|
|
+ }
|
|
|
+
|
|
|
+ $this->view = $view;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set grid title.
|
|
|
+ *
|
|
|
+ * @param string $title
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function title($title)
|
|
|
+ {
|
|
|
+ $this->variables['title'] = $title;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set grid description.
|
|
|
+ *
|
|
|
+ * @param string $description
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function description($description)
|
|
|
+ {
|
|
|
+ $this->variables['description'] = $description;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Set resource path for grid.
|
|
|
+ *
|
|
|
+ * @param string $path
|
|
|
+ *
|
|
|
+ * @return $this
|
|
|
+ */
|
|
|
+ public function setResource($path)
|
|
|
+ {
|
|
|
+ $this->resourcePath = $path;
|
|
|
+
|
|
|
+ return $this;
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Get the string contents of the grid view.
|
|
|
+ *
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ public function render()
|
|
|
+ {
|
|
|
+ $this->handleExportRequest();
|
|
|
+
|
|
|
+ try {
|
|
|
+ $this->callComposing();
|
|
|
+
|
|
|
+ $this->build();
|
|
|
+ } catch (\Throwable $e) {
|
|
|
+ return Admin::makeExceptionHandler()->renderException($e);
|
|
|
+ }
|
|
|
+
|
|
|
+ return $this->doWrap();
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * @return string
|
|
|
+ */
|
|
|
+ protected function doWrap()
|
|
|
+ {
|
|
|
+ $view = view($this->view, $this->variables());
|
|
|
+
|
|
|
+ if (! $wrapper = $this->wrapper) {
|
|
|
+ return $view->render();
|
|
|
+ }
|
|
|
+
|
|
|
+ return $wrapper($view);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Add column to grid.
|
|
|
+ *
|
|
|
+ * @param string $name
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ public function __get($name)
|
|
|
+ {
|
|
|
+ return $this->addColumn($name);
|
|
|
+ }
|
|
|
+
|
|
|
+ /**
|
|
|
+ * Dynamically add columns to the grid view.
|
|
|
+ *
|
|
|
+ * @param $method
|
|
|
+ * @param $arguments
|
|
|
+ *
|
|
|
+ * @return Column
|
|
|
+ */
|
|
|
+ public function __call($method, $arguments)
|
|
|
+ {
|
|
|
+ if (static::hasMacro($method)) {
|
|
|
+ return $this->macroCall($method, $arguments);
|
|
|
+ }
|
|
|
+
|
|
|
+ return $this->addColumn($method, $arguments[0] ?? null);
|
|
|
+ }
|
|
|
+}
|
jqh