Itstructure\GridView\Columns\BaseColumn

Complexity

Total Complexity

28

Size/Duplication

Total Lines	188
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	4

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	1
A	getValue()	0	3	1
A	render()	0	4	1
A	formatTo()	0	4	1
A	getLabel()	0	4	1
A	getAttribute()	0	4	1
A	getSort()	0	7	4
A	getFilter()	0	4	1
A	setFilter()	0	4	1
B	buildFilter()	0	21	7
A	setFormatter()	0	4	1
B	buildFormatter()	0	19	8

<?php

namespace Itstructure\GridView\Columns;

use Exception;
use Itstructure\GridView\Filters\{BaseFilter, StubFilter, TextFilter};
use Itstructure\GridView\Formatters\{HtmlFormatter, ImageFormatter, TextFormatter, UrlFormatter};
use Itstructure\GridView\Interfaces\Formattable;
use Itstructure\GridView\Traits\{Configurable, Attributable};

/**
 * Class BaseColumn
 * @package Itstructure\GridView\Columns
 */
abstract class BaseColumn
{
    use Configurable, Attributable;

    const
        FORMATTER_HTML = 'html',
        FORMATTER_IMAGE = 'image',
        FORMATTER_TEXT = 'text',
        FORMATTER_URL = 'url',

        FORMATTER_DEFINITIONS = [
            self::FORMATTER_HTML => HtmlFormatter::class,
            self::FORMATTER_IMAGE => ImageFormatter::class,
            self::FORMATTER_TEXT => TextFormatter::class,
            self::FORMATTER_URL => UrlFormatter::class,
        ];

    /**
     * @var string
     */
    protected $label;

    /**
     * @var string
     */
    protected $attribute;

    /**
     * @var bool|null|string
     */
    protected $sort;

    /**
     * @var string $value
     */
    protected $value;

    /**
     * @var bool|null|string|BaseFilter
     */
    protected $filter;

    /**
     * @var string|Formattable
     */
    protected $format;

    /**
     * BaseColumn constructor.
     * @param array $config
     */
    public function __construct(array $config)
    {
        $this->loadConfig($config);
        $this->buildFilter();
        $this->buildFormatter();
    }

    /**
     * @param $row
     * @return mixed
     */
    public function getValue($row)
    {
    }

    /**
     * Render row attribute value.
     * @param $row
     * @return mixed
     */
    public function render($row)
    {
        return $this->formatTo($this->getValue($row));
    }

    /**
     * Format value with formatter.
     * @param $value
     * @return mixed
     */
    public function formatTo($value)
    {
        return $this->format->format($value);
    }

    /**
     * Get title for grid head.
     * @return string
     */
    public function getLabel(): string
    {
        return $this->label ?? ucfirst($this->attribute);
    }

    /**
     * Get attribute.
     * @return string|null
     */
    public function getAttribute()
    {
        return $this->attribute;
    }

    /**
     * @return bool|null|string
     */
    public function getSort()
    {
        if (is_null($this->sort) || $this->sort === true) {
            return is_null($this->attribute) ? false : $this->attribute;
        }
        return $this->sort;
    }

    /**
     * @return BaseFilter
     */
    public function getFilter()
    {
        return $this->filter;

The return type of return $this->filter; (boolean|null|string|BaseFilter) is incompatible with the return type documented by Itstructure\GridView\Columns\BaseColumn::getFilter of type BaseFilter|null.

    }

    /**
     * @param BaseFilter $filter
     */
    protected function setFilter(BaseFilter $filter): void
    {
        $this->filter = $filter;

It seems like $filter of type object<Itstructure\GridView\Filters\BaseFilter> is incompatible with the declared type boolean|null|string|object<BaseFilter> of property $filter.

    }

    /**
     * @return void
     */
    protected function buildFilter(): void
    {
        if ($this->filter === false) {
            $this->filter = new StubFilter();

It seems like new \Itstructure\GridView\Filters\StubFilter() of type object<Itstructure\GridView\Filters\StubFilter> is incompatible with the declared type boolean|null|string|object<BaseFilter> of property $filter.

        } else if (is_null($this->filter)) {
            $this->filter = new TextFilter([

It seems like new \Itstructure\GridView\Filters\TextFilter(array('name' => $this->getAttribute())) of type object<Itstructure\GridView\Filters\TextFilter> is incompatible with the declared type boolean|null|string|object<BaseFilter> of property $filter.

                'name' => $this->getAttribute(),
            ]);

        } else if (is_array($this->filter)) {
            if (isset($this->filter['class']) && class_exists($this->filter['class'])) {
                $this->setFilter(
                    new $this->filter['class'](array_merge($this->filter, empty($this->filter['name']) ? [
                            'name' => $this->getAttribute()
                        ] : [])
                    )
                );
            }
        }
    }

    /**
     * @param Formattable $formatter
     */
    protected function setFormatter(Formattable $formatter): void
    {
        $this->format = $formatter;
    }

    /**
     * @throws Exception
     * @return void
     */
    protected function buildFormatter(): void
    {
        if (is_null($this->format)) {
            $class = self::FORMATTER_DEFINITIONS[self::FORMATTER_TEXT];
            $this->format = new $class;

        } else if (is_string($this->format)) {
            $class = self::FORMATTER_DEFINITIONS[$this->format] ?? self::FORMATTER_DEFINITIONS[self::FORMATTER_TEXT];
            $this->format = new $class;

        } else if (is_array($this->format)) {
            if (isset($this->format['class']) && class_exists($this->format['class'])) {
                $this->setFormatter(new $this->format['class']($this->format));
            }

        } else if (!is_object($this->format) || !($this->format instanceof Formattable)) {
            throw new Exception('Incorrect formatter.');
        }
    }
}