deniskoronets / Laravel-GridView

src/Columns/CallbackColumn.php

Indentation +20 added lines, -20 removed lines

@@ -4,26 +4,26 @@
 
 class CallbackColumn extends BaseColumn
 {
-    /**
-     * @var string
-     */
-    public $formatters = ['raw'];
+	/**
+	 * @var string
+	 */
+	public $formatters = ['raw'];
 
-    /**
-     * @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/Columns/ViewColumn.php

Indentation +11 added lines, -11 removed lines

@@ -7,16 +7,16 @@
 
 class ViewColumn extends BaseColumn
 {
-    public $formatters = [];
+	public $formatters = [];
 
-    /**
-     * Render column value for row
-     * @param array|object $row
-     * @return string|mixed
-     * @throws Throwable
-     */
-    protected function _renderValue($row)
-    {
-        return view($this->value, $row)->render();
-    }
+	/**
+	 * Render column value for row
+	 * @param array|object $row
+	 * @return string|mixed
+	 * @throws Throwable
+	 */
+	protected function _renderValue($row)
+	{
+		return view($this->value, $row)->render();
+	}
 }
\ No newline at end of file

src/Renderers/BaseRenderer.php

Indentation +24 added lines, -24 removed lines

@@ -9,32 +9,32 @@
 
 abstract class BaseRenderer
 {
-    use Configurable;
+	use Configurable;
 
-    /**
-     * @var GridView
-     */
-    public $gridView;
+	/**
+	 * @var GridView
+	 */
+	public $gridView;
 
-    /**
-     * BaseRenderer constructor.
-     * @param $config
-     * @throws GridViewConfigException
-     */
-    public function __construct($config)
-    {
-        $this->loadConfig($config);
-    }
+	/**
+	 * BaseRenderer constructor.
+	 * @param $config
+	 * @throws GridViewConfigException
+	 */
+	public function __construct($config)
+	{
+		$this->loadConfig($config);
+	}
 
-    /**
-     * @return array
-     */
-    protected function configTests(): array
-    {
-        return [
-            'gridView' => GridView::class,
-        ];
-    }
+	/**
+	 * @return array
+	 */
+	protected function configTests(): array
+	{
+		return [
+			'gridView' => GridView::class,
+		];
+	}
 
-    public abstract function render() : string;
+	public abstract function render() : string;
 }
\ No newline at end of file

src/Renderers/DefaultRenderer.php

Indentation +17 added lines, -17 removed lines

@@ -7,22 +7,22 @@
 
 class DefaultRenderer extends BaseRenderer
 {
-    /**
-     * @return string
-     * @throws \Throwable
-     */
-    public function render(): string
-    {
-        $filters = [];
-        foreach ($this->gridView->columns as $column) {
-            if ($column->filter) {
-                $filters[$column->filter->name] = $this->gridView->getRequest()->getFilterValue($column->filter->name);
-            }
-        }
+	/**
+	 * @return string
+	 * @throws \Throwable
+	 */
+	public function render(): string
+	{
+		$filters = [];
+		foreach ($this->gridView->columns as $column) {
+			if ($column->filter) {
+				$filters[$column->filter->name] = $this->gridView->getRequest()->getFilterValue($column->filter->name);
+			}
+		}
 
-        return view('woo_gridview::renderers.default', [
-            'grid' => $this->gridView,
-            'filters' => $filters,
-        ])->render();
-    }
+		return view('woo_gridview::renderers.default', [
+			'grid' => $this->gridView,
+			'filters' => $filters,
+		])->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, got ' . print_r($this->$property, 1);
-                }
-            }
-
-            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, got ' . print_r($this->$property, 1);
+				}
+			}
+
+			if (!$testPassed) {
+				throw new GridViewConfigException(
+					'Tests ' . $tests . ' has failed on ' . get_class($this) . '::' . $property . ': ' . $testMessage
+				);
+			}
+		}
+	}
 }
\ No newline at end of file

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);
+	return new \Woo\GridView\GridView($config);
 }
\ No newline at end of file

src/Columns/Actions/Action.php

Doc Comments +1 added lines, -1 removed lines

@@ -23,7 +23,7 @@
 
     /**
      * Action constructor.
-     * @param string|Closure $url
+     * @param string $url
      * @param string $content
      * @param string $method
      */

Indentation +47 added lines, -47 removed lines

@@ -6,63 +6,63 @@
 
 class Action
 {
-    /**
-     * @var string
-     */
-    protected $url;
+	/**
+	 * @var string
+	 */
+	protected $url;
 
-    /**
-     * @var string
-     */
-    protected $content;
+	/**
+	 * @var string
+	 */
+	protected $content;
 
-    /**
-     * @var string
-     */
-    protected $method;
+	/**
+	 * @var string
+	 */
+	protected $method;
 
-    /**
-     * Action constructor.
-     * @param string|Closure $url
-     * @param string $content
-     * @param string $method
-     */
-    public function __construct($url, string $content, string $method = 'GET')
-    {
-        $this->url = $url;
+	/**
+	 * Action constructor.
+	 * @param string|Closure $url
+	 * @param string $content
+	 * @param string $method
+	 */
+	public function __construct($url, string $content, string $method = 'GET')
+	{
+		$this->url = $url;
 
-        $this->content = $content;
+		$this->content = $content;
 
-        $this->method = $method;
-    }
+		$this->method = $method;
+	}
 
-    protected function buildUrl($row)
-    {
-        if ($this->url instanceof Closure) {
-            return call_user_func($this->url, $row);
-        }
+	protected function buildUrl($row)
+	{
+		if ($this->url instanceof Closure) {
+			return call_user_func($this->url, $row);
+		}
 
-        return preg_replace_callback('/\{([\w\_]+)\}/', function($match) use ($row) {
+		return preg_replace_callback('/\{([\w\_]+)\}/', function($match) use ($row) {
 
-            $match = $match[1];
+			$match = $match[1];
 
-            if (isset($row->$match)) {
-                return $row->$match;
+			if (isset($row->$match)) {
+				return $row->$match;
 
-            } elseif (isset($row[$match])) {
-                return $row[$match];
-            }
+			} elseif (isset($row[$match])) {
+				return $row[$match];
+			}
 
-            return '';
-        }, $this->url);
-    }
+			return '';
+		}, $this->url);
+	}
 
-    public function render($row)
-    {
-        return view('woo_gridview::columns.action', [
-            'url' => $this->buildUrl($row),
-            'content' => $this->content,
-            'method' => $this->method,
-        ])->render();
-    }
+	public function render($row)
+	{
+		return view('woo_gridview::columns.action', [
+			'url' => $this->buildUrl($row),
+			'content' => $this->content,
+			'method' => $this->method,
+		])->render();
+	}
 }
\ No newline at end of file

src/GridViewHelper.php

Indentation +128 added lines, -128 removed lines

@@ -20,132 +20,132 @@
 
 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,
-        ],
-        '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,
-        ]
-    ];
-
-    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 . ']';
-    }
+	/**
+	 * 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,
+		],
+		'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,
+		]
+	];
+
+	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 . ']';
+	}
 }
\ No newline at end of file

src/Columns/BaseColumn.php

Indentation +141 added lines, -141 removed lines

@@ -9,146 +9,146 @@
 
 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
-     */
-    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();
-    }
-
-    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' => 'bool',
-            '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
+	 */
+	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();
+	}
+
+	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' => 'bool',
+			'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;
+	}
 
 }
\ No newline at end of file