deniskoronets / Laravel-GridView

src/functions.php

Indentation +1 added lines, -1 removed lines

@@ -7,5 +7,5 @@
  * @throws \Woo\GridView\Exceptions\GridViewConfigException
  */
 function grid(array $config) {
-    return (new \Woo\GridView\GridView($config))->render();
+	return (new \Woo\GridView\GridView($config))->render();
 }
\ No newline at end of file

src/Traits/Configurable.php

Indentation +84 added lines, -84 removed lines

@@ -7,88 +7,88 @@
 
 trait Configurable
 {
-    /**
-     * Allows to load config into object properties
-     * @param array $config
-     * @throws GridViewConfigException
-     */
-    public function loadConfig(array $config)
-    {
-        foreach ($config as $key => $value) {
-
-            if (property_exists($this, $key)) {
-                $this->$key = $value;
-            }
-        }
-
-        $this->testConfig();
-    }
-
-    /**
-     * Should specify tests
-     * @return array
-     */
-    abstract protected function configTests() : array;
-
-    /**
-     * Allows to test attributes and types in config
-     * @throws GridViewConfigException
-     */
-    protected function testConfig()
-    {
-        foreach ($this->configTests() as $property => $tests) {
-
-            if (!property_exists($this, $property)) {
-                throw new GridViewConfigException(
-                    'Unable to test ' . get_class($this) . ': property ' . $property . ' does not exist'
-                );
-            }
-
-            $testPassed = true;
-            $testMessage = 'Validation failed';
-
-            foreach (explode('|', $tests) as $test) {
-
-                switch ($test) {
-                    case 'int':
-                        $testPassed = is_numeric($this->$property);
-                        $testMessage = 'Property should be numeric';
-                        break;
-
-                    case 'string':
-                        $testPassed = is_string($this->$property);
-                        $testMessage = 'Property should be a string';
-                        break;
-
-                    case 'array':
-                        $testPassed = is_array($this->$property);
-                        $testMessage = 'Property should be an array';
-                        break;
-
-                    case 'closure':
-                        $testPassed = $this->$property instanceof Closure;
-                        $testMessage = 'Property should be a valid callback (Closure instance)';
-                        break;
-
-                    case 'boolean':
-                        $testPassed = is_bool($this->$property);
-                        $testMessage = 'Property should be boolean';
-                        break;
-
-                    case 'any':
-                        break;
-
-                    default:
-                        $testPassed = $testPassed || is_a($this->$property, $test) || is_subclass_of($this->$property, $test);
-                        $testMessage = 'Property should be ' . $test . ' instance/class reference, check ' . $property;
-                }
-            }
-
-            if (!$testPassed) {
-                throw new GridViewConfigException(
-                    'Tests ' . $tests . ' has failed on ' . get_class($this) . '::' . $property . ': ' . $testMessage
-                );
-            }
-        }
-    }
+	/**
+	 * Allows to load config into object properties
+	 * @param array $config
+	 * @throws GridViewConfigException
+	 */
+	public function loadConfig(array $config)
+	{
+		foreach ($config as $key => $value) {
+
+			if (property_exists($this, $key)) {
+				$this->$key = $value;
+			}
+		}
+
+		$this->testConfig();
+	}
+
+	/**
+	 * Should specify tests
+	 * @return array
+	 */
+	abstract protected function configTests() : array;
+
+	/**
+	 * Allows to test attributes and types in config
+	 * @throws GridViewConfigException
+	 */
+	protected function testConfig()
+	{
+		foreach ($this->configTests() as $property => $tests) {
+
+			if (!property_exists($this, $property)) {
+				throw new GridViewConfigException(
+					'Unable to test ' . get_class($this) . ': property ' . $property . ' does not exist'
+				);
+			}
+
+			$testPassed = true;
+			$testMessage = 'Validation failed';
+
+			foreach (explode('|', $tests) as $test) {
+
+				switch ($test) {
+					case 'int':
+						$testPassed = is_numeric($this->$property);
+						$testMessage = 'Property should be numeric';
+						break;
+
+					case 'string':
+						$testPassed = is_string($this->$property);
+						$testMessage = 'Property should be a string';
+						break;
+
+					case 'array':
+						$testPassed = is_array($this->$property);
+						$testMessage = 'Property should be an array';
+						break;
+
+					case 'closure':
+						$testPassed = $this->$property instanceof Closure;
+						$testMessage = 'Property should be a valid callback (Closure instance)';
+						break;
+
+					case 'boolean':
+						$testPassed = is_bool($this->$property);
+						$testMessage = 'Property should be boolean';
+						break;
+
+					case 'any':
+						break;
+
+					default:
+						$testPassed = $testPassed || is_a($this->$property, $test) || is_subclass_of($this->$property, $test);
+						$testMessage = 'Property should be ' . $test . ' instance/class reference, check ' . $property;
+				}
+			}
+
+			if (!$testPassed) {
+				throw new GridViewConfigException(
+					'Tests ' . $tests . ' has failed on ' . get_class($this) . '::' . $property . ': ' . $testMessage
+				);
+			}
+		}
+	}
 }
\ No newline at end of file

src/Formatters/BooleanFormatter.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 class BooleanFormatter implements IFormatter
 {
-    public function format($value): string
-    {
-        return $value ? 'Yes' : 'No';
-    }
+	public function format($value): string
+	{
+		return $value ? 'Yes' : 'No';
+	}
 }
\ No newline at end of file

src/Formatters/RawFormatter.php

Indentation +4 added lines, -4 removed lines

@@ -4,8 +4,8 @@
 
 class RawFormatter implements IFormatter
 {
-    public function format($value): string
-    {
-        return $value;
-    }
+	public function format($value): string
+	{
+		return $value;
+	}
 }
\ No newline at end of file

src/Columns/CallbackColumn.php

Indentation +24 added lines, -24 removed lines

@@ -4,31 +4,31 @@
 
 class CallbackColumn extends BaseColumn
 {
-    /**
-     * @var string
-     */
-    public $formatters = ['raw'];
+	/**
+	 * @var string
+	 */
+	public $formatters = ['raw'];
 
-    /**
-     * @var bool
-     */
-    public $sortable = false;
+	/**
+	 * @var bool
+	 */
+	public $sortable = false;
 
-    /**
-     * @return array
-     */
-    protected function configTests(): array
-    {
-        return array_merge(parent::configTests(), [
-            'value' => 'closure',
-        ]);
-    }
+	/**
+	 * @return array
+	 */
+	protected function configTests(): array
+	{
+		return array_merge(parent::configTests(), [
+			'value' => 'closure',
+		]);
+	}
 
-    /**
-     * @inheritdoc
-     */
-    public function _renderValue($row)
-    {
-        return call_user_func($this->value, $row);
-    }
+	/**
+	 * @inheritdoc
+	 */
+	public function _renderValue($row)
+	{
+		return call_user_func($this->value, $row);
+	}
 }
\ No newline at end of file

src/GridViewHelper.php

Indentation +140 added lines, -140 removed lines

@@ -23,144 +23,144 @@
 
 class GridViewHelper
 {
-    /**
-     * A list of grid aliases
-     * @var array
-     */
-    private static $aliases = [
-        'column' => [
-            'attribute' => AttributeColumn::class,
-            'raw' => CallbackColumn::class,
-            'callback' => CallbackColumn::class,
-            'actions' => ActionsColumn::class,
-            'view' => ViewColumn::class,
-        ],
-        'formatter' => [
-            'email' => EmailFormatter::class,
-            'image' => ImageFormatter::class,
-            'text' => TextFormatter::class,
-            'url' => UrlFormatter::class,
-            'raw' => RawFormatter::class,
-        ],
-        'filter' => [
-            'text' => TextFilter::class,
-            'dropdown' => DropdownFilter::class,
-        ],
-        'renderer' => [
-            'default' => DefaultRenderer::class,
-        ],
-        'action' => [
-            'delete' => DeleteAction::class,
-            'update' => EditAction::class,
-            'edit' => EditAction::class,
-            'show' => ShowAction::class,
-            'view' => ShowAction::class,
-            'action' => Action::class,
-        ]
-    ];
-
-    private function __construct() {}
-
-    /**
-     * Useful in case you want to register a new alias for your project
-     * @param string $context
-     * @param string $alias
-     * @param string $aliasTo
-     */
-    public static function registerAlias(string $context, string $alias, string $aliasTo)
-    {
-        self::$aliases[$context][$alias] = $aliasTo;
-    }
-
-    /**
-     * Allows to resolve class name by its alias
-     * @param string $context
-     * @param string $alias
-     * @return mixed
-     */
-    public static function resolveAlias(string $context, string $alias)
-    {
-        return self::$aliases[$context][$alias] ?? $alias;
-    }
-
-    /**
-     * Allows to convert options array to html string
-     * @param array $htmlOptions
-     * @param array $context - context is variables, which are allowed to use when property value calculated dynamically
-     * @return string
-     */
-    public static function htmlOptionsToString(array $htmlOptions, array $context = []) : string
-    {
-        if (empty($htmlOptions)) {
-            return '';
-        }
-
-        $out = [];
-
-        foreach ($htmlOptions as $k => $v) {
-
-            if ($v instanceof \Closure) {
-                $v = call_user_func_array($v, $context);
-            }
-
-            $out[] = htmlentities($k) . '="' . htmlentities($v, ENT_COMPAT) . '"';
-        }
-
-        return implode(' ', $out);
-    }
-
-    /**
-     * Allows to make column title by it key or attribute name
-     * @param string|int $key
-     * @return string
-     */
-    public static function columnTitle($key) : string
-    {
-        if (is_numeric($key)) {
-            return 'Column';
-        }
-
-        return ucwords(
-            trim(
-                preg_replace_callback(
-                    '/([A-Z]|_|\.)/',
-                    function($word) {
-                        $word = $word[0];
-
-                        if ($word == '_' || $word == '.') {
-                            return ' ';
-                        }
-
-                        return ' ' . strtolower($word);
-                    },
-                    $key
-                )
-            )
-        );
-    }
-
-    /**
-     * Helper for internal purposes
-     * @param $id
-     * @param $component
-     * @return string
-     */
-    public static function gridIdFormatter($id, $component)
-    {
-        if ($id == 0) {
-            return $component;
-        }
-
-        return 'grid[' . $id . '][' . $component . ']';
-    }
-
-    /**
-     * Generates page url with all requested params from request
-     * @param $gridId
-     * @param $page
-     */
-    public static function pageUrl($gridId, $page)
-    {
-        return url()->current() . '?' . Arr::query([\Woo\GridView\GridViewHelper::gridIdFormatter($gridId, 'page') => $page] + request()->query());
-    }
+	/**
+	 * A list of grid aliases
+	 * @var array
+	 */
+	private static $aliases = [
+		'column' => [
+			'attribute' => AttributeColumn::class,
+			'raw' => CallbackColumn::class,
+			'callback' => CallbackColumn::class,
+			'actions' => ActionsColumn::class,
+			'view' => ViewColumn::class,
+		],
+		'formatter' => [
+			'email' => EmailFormatter::class,
+			'image' => ImageFormatter::class,
+			'text' => TextFormatter::class,
+			'url' => UrlFormatter::class,
+			'raw' => RawFormatter::class,
+		],
+		'filter' => [
+			'text' => TextFilter::class,
+			'dropdown' => DropdownFilter::class,
+		],
+		'renderer' => [
+			'default' => DefaultRenderer::class,
+		],
+		'action' => [
+			'delete' => DeleteAction::class,
+			'update' => EditAction::class,
+			'edit' => EditAction::class,
+			'show' => ShowAction::class,
+			'view' => ShowAction::class,
+			'action' => Action::class,
+		]
+	];
+
+	private function __construct() {}
+
+	/**
+	 * Useful in case you want to register a new alias for your project
+	 * @param string $context
+	 * @param string $alias
+	 * @param string $aliasTo
+	 */
+	public static function registerAlias(string $context, string $alias, string $aliasTo)
+	{
+		self::$aliases[$context][$alias] = $aliasTo;
+	}
+
+	/**
+	 * Allows to resolve class name by its alias
+	 * @param string $context
+	 * @param string $alias
+	 * @return mixed
+	 */
+	public static function resolveAlias(string $context, string $alias)
+	{
+		return self::$aliases[$context][$alias] ?? $alias;
+	}
+
+	/**
+	 * Allows to convert options array to html string
+	 * @param array $htmlOptions
+	 * @param array $context - context is variables, which are allowed to use when property value calculated dynamically
+	 * @return string
+	 */
+	public static function htmlOptionsToString(array $htmlOptions, array $context = []) : string
+	{
+		if (empty($htmlOptions)) {
+			return '';
+		}
+
+		$out = [];
+
+		foreach ($htmlOptions as $k => $v) {
+
+			if ($v instanceof \Closure) {
+				$v = call_user_func_array($v, $context);
+			}
+
+			$out[] = htmlentities($k) . '="' . htmlentities($v, ENT_COMPAT) . '"';
+		}
+
+		return implode(' ', $out);
+	}
+
+	/**
+	 * Allows to make column title by it key or attribute name
+	 * @param string|int $key
+	 * @return string
+	 */
+	public static function columnTitle($key) : string
+	{
+		if (is_numeric($key)) {
+			return 'Column';
+		}
+
+		return ucwords(
+			trim(
+				preg_replace_callback(
+					'/([A-Z]|_|\.)/',
+					function($word) {
+						$word = $word[0];
+
+						if ($word == '_' || $word == '.') {
+							return ' ';
+						}
+
+						return ' ' . strtolower($word);
+					},
+					$key
+				)
+			)
+		);
+	}
+
+	/**
+	 * Helper for internal purposes
+	 * @param $id
+	 * @param $component
+	 * @return string
+	 */
+	public static function gridIdFormatter($id, $component)
+	{
+		if ($id == 0) {
+			return $component;
+		}
+
+		return 'grid[' . $id . '][' . $component . ']';
+	}
+
+	/**
+	 * Generates page url with all requested params from request
+	 * @param $gridId
+	 * @param $page
+	 */
+	public static function pageUrl($gridId, $page)
+	{
+		return url()->current() . '?' . Arr::query([\Woo\GridView\GridViewHelper::gridIdFormatter($gridId, 'page') => $page] + request()->query());
+	}
 }

src/Columns/BaseColumn.php

Indentation +161 added lines, -161 removed lines

@@ -9,166 +9,166 @@
 
 abstract class BaseColumn
 {
-    use Configurable;
-
-    /**
-     * Column title
-     * @var string
-     */
-    public $title = '';
-
-    /**
-     * Column value. Could be an attribute,
-     * @var string|mixed
-     */
-    public $value = '';
-
-    /**
-     * @var BaseFilter
-     */
-    public $filter;
-
-    /**
-     * @var boolean|string
-     */
-    public $sortable = true;
-
-    /**
-     * @var array
-     */
-    public $headerHtmlOptions = [];
-
-    /**
-     * @var array
-     */
-    public $contentHtmlOptions = [];
-
-    /**
-     * @var array - allowed: raw, url, email, text, image
-     */
-    public $formatters = ['text'];
-
-    /**
-     * Value when column is empty
-     * @var string
-     */
-    public $emptyValue = '-';
-
-    /**
-     * BaseColumn constructor.
-     * @param array $config
-     * @throws \Woo\GridView\Exceptions\GridViewConfigException
-     */
-    public function __construct(array $config)
-    {
-        $this->loadConfig($config);
-
-        $this->buildFilter();
-    }
-
-    /**
-     * Allows to get sortable column's name
-     */
-    public function getSortableName()
-    {
-        if ($this->sortable === false) {
-            return false;
-        }
-
-        if (!is_bool($this->sortable)) {
-            return $this->sortable;
-        }
-
-        if (is_scalar($this->value)) {
-            return $this->value;
-        }
-
-        return false;
-    }
-
-    protected function buildFilter()
-    {
-        if (is_null($this->filter) || is_object($this->filter)) {
-            return;
-        }
-
-        if (is_string($this->filter)) {
-            $this->filter = [
-                'class' => $this->filter,
-                'name' => $this->value,
-            ];
-        }
-
-        if (empty($this->filter['class'])) {
-            $this->filter['class'] = TextFilter::class;
-        }
-
-        if (empty($this->filter['name'])) {
-            $this->filter['name'] = $this->value;
-        }
-
-        $className = GridViewHelper::resolveAlias('filter', $this->filter['class']);
-        $this->filter = new $className($this->filter);
-    }
-
-    /**
-     * @return array
-     */
-    protected function configTests(): array
-    {
-        return [
-            'title' => 'string',
-            'value' => 'any',
-            'headerHtmlOptions' => 'array',
-            'contentHtmlOptions' => 'array',
-            'formatters' => 'array',
-            'emptyValue' => 'string',
-            'sortable' => 'any',
-            'filter' => BaseFilter::class . '|null',
-        ];
-    }
-
-    /**
-     * Formatted header html options
-     * @return string
-     */
-    public function compileHeaderHtmlOptions() : string
-    {
-        return GridViewHelper::htmlOptionsToString($this->headerHtmlOptions);
-    }
-
-    /**
-     * Formatted content html options
-     * @param array $context
-     * @return string
-     */
-    public function compileContentHtmlOptions(array $context) : string
-    {
-        return GridViewHelper::htmlOptionsToString($this->contentHtmlOptions, $context);
-    }
-
-    /**
-     * Render column value for row
-     * @param array|object $row
-     * @return string|mixed
-     */
-    protected abstract function _renderValue($row);
-
-    /**
-     * Renders column content
-     * @param $row
-     * @return string
-     */
-    public function renderValue($row)
-    {
-        $value = $this->_renderValue($row);
-
-        foreach ($this->formatters as $formatter) {
-            $className = GridViewHelper::resolveAlias('formatter', $formatter);
-            $value = (new $className)->format($value);
-        }
-
-        return $value;
-    }
+	use Configurable;
+
+	/**
+	 * Column title
+	 * @var string
+	 */
+	public $title = '';
+
+	/**
+	 * Column value. Could be an attribute,
+	 * @var string|mixed
+	 */
+	public $value = '';
+
+	/**
+	 * @var BaseFilter
+	 */
+	public $filter;
+
+	/**
+	 * @var boolean|string
+	 */
+	public $sortable = true;
+
+	/**
+	 * @var array
+	 */
+	public $headerHtmlOptions = [];
+
+	/**
+	 * @var array
+	 */
+	public $contentHtmlOptions = [];
+
+	/**
+	 * @var array - allowed: raw, url, email, text, image
+	 */
+	public $formatters = ['text'];
+
+	/**
+	 * Value when column is empty
+	 * @var string
+	 */
+	public $emptyValue = '-';
+
+	/**
+	 * BaseColumn constructor.
+	 * @param array $config
+	 * @throws \Woo\GridView\Exceptions\GridViewConfigException
+	 */
+	public function __construct(array $config)
+	{
+		$this->loadConfig($config);
+
+		$this->buildFilter();
+	}
+
+	/**
+	 * Allows to get sortable column's name
+	 */
+	public function getSortableName()
+	{
+		if ($this->sortable === false) {
+			return false;
+		}
+
+		if (!is_bool($this->sortable)) {
+			return $this->sortable;
+		}
+
+		if (is_scalar($this->value)) {
+			return $this->value;
+		}
+
+		return false;
+	}
+
+	protected function buildFilter()
+	{
+		if (is_null($this->filter) || is_object($this->filter)) {
+			return;
+		}
+
+		if (is_string($this->filter)) {
+			$this->filter = [
+				'class' => $this->filter,
+				'name' => $this->value,
+			];
+		}
+
+		if (empty($this->filter['class'])) {
+			$this->filter['class'] = TextFilter::class;
+		}
+
+		if (empty($this->filter['name'])) {
+			$this->filter['name'] = $this->value;
+		}
+
+		$className = GridViewHelper::resolveAlias('filter', $this->filter['class']);
+		$this->filter = new $className($this->filter);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function configTests(): array
+	{
+		return [
+			'title' => 'string',
+			'value' => 'any',
+			'headerHtmlOptions' => 'array',
+			'contentHtmlOptions' => 'array',
+			'formatters' => 'array',
+			'emptyValue' => 'string',
+			'sortable' => 'any',
+			'filter' => BaseFilter::class . '|null',
+		];
+	}
+
+	/**
+	 * Formatted header html options
+	 * @return string
+	 */
+	public function compileHeaderHtmlOptions() : string
+	{
+		return GridViewHelper::htmlOptionsToString($this->headerHtmlOptions);
+	}
+
+	/**
+	 * Formatted content html options
+	 * @param array $context
+	 * @return string
+	 */
+	public function compileContentHtmlOptions(array $context) : string
+	{
+		return GridViewHelper::htmlOptionsToString($this->contentHtmlOptions, $context);
+	}
+
+	/**
+	 * Render column value for row
+	 * @param array|object $row
+	 * @return string|mixed
+	 */
+	protected abstract function _renderValue($row);
+
+	/**
+	 * Renders column content
+	 * @param $row
+	 * @return string
+	 */
+	public function renderValue($row)
+	{
+		$value = $this->_renderValue($row);
+
+		foreach ($this->formatters as $formatter) {
+			$className = GridViewHelper::resolveAlias('formatter', $formatter);
+			$value = (new $className)->format($value);
+		}
+
+		return $value;
+	}
 
 }

src/GridView.php

Indentation +228 added lines, -228 removed lines

@@ -15,232 +15,232 @@
 
 class GridView
 {
-    use Configurable;
-
-    /**
-     * Counter for ids
-     * @var int
-     */
-    private static $counter = 0;
-
-    /**
-     * Grid id (used for request handling, for
-     * @var int
-     */
-    private $id;
-
-    /**
-     * DataProvider provides gridview with the data for representation
-     * @var BaseDataProvider
-     */
-    public $dataProvider;
-
-    /**
-     * Columns config. You may specify array or GridColumn instance
-     * @var BaseColumn[]
-     */
-    public $columns = [];
-
-    /**
-     * Common options for all columns, will be appended to all columns configs
-     * @var array
-     */
-    public $columnOptions = [
-        'class' => AttributeColumn::class,
-    ];
-
-    /**
-     * Renders the final UI
-     * @var string|BaseRenderer
-     */
-    public $renderer = DefaultRenderer::class;
-
-    /**
-     * Allows to pass some options into renderer/customize rendered behavior
-     * @var array
-     */
-    public $rendererOptions = [];
-
-    /**
-     * Controls amount of data per page
-     * @var int
-     */
-    public $rowsPerPage = 25;
-
-    /**
-     * Allows to tune the <table> tag with html options
-     * @var array
-     */
-    public $tableHtmlOptions = [
-        'class' => 'table table-bordered gridview-table',
-    ];
-
-    /**
-     * Indicate if filters will be shown or not
-     * @var bool
-     */
-    public $showFilters = true;
-
-    /**
-     * Flags allow to change standalone vue to. If false, GridView component should be included in your root Vue instance
-     * @var bool
-     */
-    public $standaloneVue = true;
-
-    /**
-     * List of additinal params which'll be added to filter requests
-     * @var array
-     */
-    public $additionalRequestParams = [];
-
-    /**
-     * @var Paginator
-     */
-    protected $pagination;
-
-    /**
-     * @var GridViewRequest
-     */
-    protected $request;
-
-    /**
-     * GridView constructor.
-     * @param array $config
-     * @throws Exceptions\GridViewConfigException
-     */
-    public function __construct(array $config)
-    {
-        $this->id = self::$counter++;
-
-        $this->loadConfig($config);
-
-        /**
-         * Making renderer
-         */
-        if (!is_object($this->renderer)) {
-            $className = GridViewHelper::resolveAlias('renderer', $this->renderer);
-            $this->renderer = new $className(array_merge(
-                $this->rendererOptions, [
-                    'gridView' => $this,
-                ]
-            ));
-        }
-
-        /**
-         * Build columns from config
-         */
-        $this->buildColumns();
-
-        $this->request = GridViewRequest::parse($this->id);
-        $this->request->perPage = $this->rowsPerPage;
-
-        $this->pagination = new LengthAwarePaginator(
-            $this->dataProvider->getData($this->request),
-            $this->dataProvider->getCount($this->request),
-            $this->rowsPerPage,
-            $this->request->page
-        );
-    }
-
-    /**
-     * @return array
-     */
-    protected function configTests(): array
-    {
-        return [
-            'dataProvider' => BaseDataProvider::class,
-            'columns' => 'array',
-            'renderer' => BaseRenderer::class,
-            'rowsPerPage' => 'int',
-            'tableHtmlOptions' => 'array',
-            'showFilters' => 'boolean',
-        ];
-    }
-
-    /**
-     * Build columns into objects
-     */
-    protected function buildColumns()
-    {
-        foreach ($this->columns as $key => &$columnOptions) {
-
-            /**
-             * In case of when column is already build
-             */
-            if (is_object($columnOptions)) {
-                continue;
-            }
-
-            /**
-             * When only attribute name/value passed
-             */
-            if (is_string($columnOptions)) {
-                $columnOptions = [
-                    'value' => $columnOptions,
-                ];
-            }
-
-            if ($columnOptions instanceof Closure) {
-                $columnOptions = [
-                    'class' => CallbackColumn::class,
-                    'value' => $columnOptions,
-                    'title' => GridViewHelper::columnTitle($key),
-                ];
-            }
-
-            /**
-             * Inline column declaration detector
-             */
-            if (is_string($columnOptions['value']) && strpos($columnOptions['value'], 'view:') === 0) {
-                $columnOptions['class'] = 'view';
-                $columnOptions['value'] = str_replace('view:', '', $columnOptions['value']);
-            }
-
-            $columnOptions = array_merge($this->columnOptions, $columnOptions);
-
-            $className = GridViewHelper::resolveAlias('column', $columnOptions['class']);
-            $columnOptions = new $className($columnOptions);
-        }
-    }
-
-    /**
-     * Draws widget and return html code
-     * @return string
-     */
-    public function render()
-    {
-        return $this->renderer->render($this);
-    }
-
-    /**
-     * @return LengthAwarePaginator|Paginator
-     */
-    public function getPagination()
-    {
-        return $this->pagination;
-    }
-
-    /**
-     * @return GridViewRequest
-     */
-    public function getRequest()
-    {
-        return $this->request;
-    }
-
-    /**
-     * @return int
-     */
-    public function getId() : int
-    {
-        return $this->id;
-    }
-
-    /**
-     * @return string
-     */
-    public function compileTableHtmlOptions() : string
-    {
-        return GridViewHelper::htmlOptionsToString($this->tableHtmlOptions);
-    }
+	use Configurable;
+
+	/**
+	 * Counter for ids
+	 * @var int
+	 */
+	private static $counter = 0;
+
+	/**
+	 * Grid id (used for request handling, for
+	 * @var int
+	 */
+	private $id;
+
+	/**
+	 * DataProvider provides gridview with the data for representation
+	 * @var BaseDataProvider
+	 */
+	public $dataProvider;
+
+	/**
+	 * Columns config. You may specify array or GridColumn instance
+	 * @var BaseColumn[]
+	 */
+	public $columns = [];
+
+	/**
+	 * Common options for all columns, will be appended to all columns configs
+	 * @var array
+	 */
+	public $columnOptions = [
+		'class' => AttributeColumn::class,
+	];
+
+	/**
+	 * Renders the final UI
+	 * @var string|BaseRenderer
+	 */
+	public $renderer = DefaultRenderer::class;
+
+	/**
+	 * Allows to pass some options into renderer/customize rendered behavior
+	 * @var array
+	 */
+	public $rendererOptions = [];
+
+	/**
+	 * Controls amount of data per page
+	 * @var int
+	 */
+	public $rowsPerPage = 25;
+
+	/**
+	 * Allows to tune the <table> tag with html options
+	 * @var array
+	 */
+	public $tableHtmlOptions = [
+		'class' => 'table table-bordered gridview-table',
+	];
+
+	/**
+	 * Indicate if filters will be shown or not
+	 * @var bool
+	 */
+	public $showFilters = true;
+
+	/**
+	 * Flags allow to change standalone vue to. If false, GridView component should be included in your root Vue instance
+	 * @var bool
+	 */
+	public $standaloneVue = true;
+
+	/**
+	 * List of additinal params which'll be added to filter requests
+	 * @var array
+	 */
+	public $additionalRequestParams = [];
+
+	/**
+	 * @var Paginator
+	 */
+	protected $pagination;
+
+	/**
+	 * @var GridViewRequest
+	 */
+	protected $request;
+
+	/**
+	 * GridView constructor.
+	 * @param array $config
+	 * @throws Exceptions\GridViewConfigException
+	 */
+	public function __construct(array $config)
+	{
+		$this->id = self::$counter++;
+
+		$this->loadConfig($config);
+
+		/**
+		 * Making renderer
+		 */
+		if (!is_object($this->renderer)) {
+			$className = GridViewHelper::resolveAlias('renderer', $this->renderer);
+			$this->renderer = new $className(array_merge(
+				$this->rendererOptions, [
+					'gridView' => $this,
+				]
+			));
+		}
+
+		/**
+		 * Build columns from config
+		 */
+		$this->buildColumns();
+
+		$this->request = GridViewRequest::parse($this->id);
+		$this->request->perPage = $this->rowsPerPage;
+
+		$this->pagination = new LengthAwarePaginator(
+			$this->dataProvider->getData($this->request),
+			$this->dataProvider->getCount($this->request),
+			$this->rowsPerPage,
+			$this->request->page
+		);
+	}
+
+	/**
+	 * @return array
+	 */
+	protected function configTests(): array
+	{
+		return [
+			'dataProvider' => BaseDataProvider::class,
+			'columns' => 'array',
+			'renderer' => BaseRenderer::class,
+			'rowsPerPage' => 'int',
+			'tableHtmlOptions' => 'array',
+			'showFilters' => 'boolean',
+		];
+	}
+
+	/**
+	 * Build columns into objects
+	 */
+	protected function buildColumns()
+	{
+		foreach ($this->columns as $key => &$columnOptions) {
+
+			/**
+			 * In case of when column is already build
+			 */
+			if (is_object($columnOptions)) {
+				continue;
+			}
+
+			/**
+			 * When only attribute name/value passed
+			 */
+			if (is_string($columnOptions)) {
+				$columnOptions = [
+					'value' => $columnOptions,
+				];
+			}
+
+			if ($columnOptions instanceof Closure) {
+				$columnOptions = [
+					'class' => CallbackColumn::class,
+					'value' => $columnOptions,
+					'title' => GridViewHelper::columnTitle($key),
+				];
+			}
+
+			/**
+			 * Inline column declaration detector
+			 */
+			if (is_string($columnOptions['value']) && strpos($columnOptions['value'], 'view:') === 0) {
+				$columnOptions['class'] = 'view';
+				$columnOptions['value'] = str_replace('view:', '', $columnOptions['value']);
+			}
+
+			$columnOptions = array_merge($this->columnOptions, $columnOptions);
+
+			$className = GridViewHelper::resolveAlias('column', $columnOptions['class']);
+			$columnOptions = new $className($columnOptions);
+		}
+	}
+
+	/**
+	 * Draws widget and return html code
+	 * @return string
+	 */
+	public function render()
+	{
+		return $this->renderer->render($this);
+	}
+
+	/**
+	 * @return LengthAwarePaginator|Paginator
+	 */
+	public function getPagination()
+	{
+		return $this->pagination;
+	}
+
+	/**
+	 * @return GridViewRequest
+	 */
+	public function getRequest()
+	{
+		return $this->request;
+	}
+
+	/**
+	 * @return int
+	 */
+	public function getId() : int
+	{
+		return $this->id;
+	}
+
+	/**
+	 * @return string
+	 */
+	public function compileTableHtmlOptions() : string
+	{
+		return GridViewHelper::htmlOptionsToString($this->tableHtmlOptions);
+	}
 }

src/DataProviders/BaseDataProvider.php

Indentation +54 added lines, -54 removed lines

@@ -6,58 +6,58 @@
 
 abstract class BaseDataProvider
 {
-    /**
-     * true means that all request filters are accepted, checks by default comparing (like)
-     * false means that filtering is not enabled in this dataprovider
-     * array should contain array of fields, available for filtering.
-     *      if key not specified, value should be a name of field, otherwise key - field name,
-     *      value - comparing type (=, like) or a callable function
-     * @var bool|array
-     */
-    protected $filters = false;
-
-    /**
-     * true means that all request sortings are accepted, checks by default sorting
-     * false means that ordering is not enabled in this dataprovider
-     * array should contain array of fields, available for filtering.
-     *      value should be a string
-     * @var bool|array
-     */
-    protected $ordering = false;
-
-    /**
-     * Should return total amount of rows
-     * @param GridViewRequest $request
-     * @return int
-     */
-    abstract public function getCount(GridViewRequest $request) : int;
-
-    /**
-     * Should return a list of data for current page
-     * @param GridViewRequest $request
-     * @return mixed
-     */
-    abstract public function getData(GridViewRequest $request);
-
-    /**
-     * Allows to set a list of fields, available for filtering
-     * @param array|boolean $filters
-     * @return $this
-     */
-    public function setFilters($filters)
-    {
-        $this->filters = $filters;
-        return $this;
-    }
-
-    /**
-     * Allows to set a list of ordering fields
-     * @param array|boolean $ordering
-     * @return $this
-     */
-    public function setOrdering($ordering)
-    {
-        $this->ordering = $ordering;
-        return $this;
-    }
+	/**
+	 * true means that all request filters are accepted, checks by default comparing (like)
+	 * false means that filtering is not enabled in this dataprovider
+	 * array should contain array of fields, available for filtering.
+	 *      if key not specified, value should be a name of field, otherwise key - field name,
+	 *      value - comparing type (=, like) or a callable function
+	 * @var bool|array
+	 */
+	protected $filters = false;
+
+	/**
+	 * true means that all request sortings are accepted, checks by default sorting
+	 * false means that ordering is not enabled in this dataprovider
+	 * array should contain array of fields, available for filtering.
+	 *      value should be a string
+	 * @var bool|array
+	 */
+	protected $ordering = false;
+
+	/**
+	 * Should return total amount of rows
+	 * @param GridViewRequest $request
+	 * @return int
+	 */
+	abstract public function getCount(GridViewRequest $request) : int;
+
+	/**
+	 * Should return a list of data for current page
+	 * @param GridViewRequest $request
+	 * @return mixed
+	 */
+	abstract public function getData(GridViewRequest $request);
+
+	/**
+	 * Allows to set a list of fields, available for filtering
+	 * @param array|boolean $filters
+	 * @return $this
+	 */
+	public function setFilters($filters)
+	{
+		$this->filters = $filters;
+		return $this;
+	}
+
+	/**
+	 * Allows to set a list of ordering fields
+	 * @param array|boolean $ordering
+	 * @return $this
+	 */
+	public function setOrdering($ordering)
+	{
+		$this->ordering = $ordering;
+		return $this;
+	}
 }