Boduch\Grid\Column

Complexity

Total Complexity

29

Size/Duplication

Total Lines	289
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setGrid()	0	6	1
A	getGrid()	0	4	1
A	getTitle()	0	4	1
A	setTitle()	0	6	1
A	getName()	0	4	1
A	setName()	0	6	1
A	isSortable()	0	4	1
A	setSortable()	0	6	1
A	setClickable()	0	6	1
A	setRender()	0	6	1
A	setPlaceholder()	0	6	1
A	addDecorator()	0	6	1
A	setDecorators()	0	6	1
A	getDecorators()	0	4	1
A	setFilter()	0	7	1
A	getFilter()	0	4	1
A	isFilterable()	0	4	1
C	setDefaultOptions()	0	30	7
A	__get()	0	12	2
A	isAutoescape()	0	4	1
A	setAutoescape()	0	6	1

<?php

namespace Boduch\Grid;

use Boduch\Grid\Decorators\DecoratorInterface;
use Boduch\Grid\Decorators\Link;
use Boduch\Grid\Decorators\Html;
use Boduch\Grid\Decorators\Placeholder;
use Boduch\Grid\Filters\FilterInterface;

class Column
{
    /**
     * @var Grid
     */
    protected $grid;

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

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

    /**
     * @var bool
     */
    protected $sortable = false;

    /**
     * @var DecoratorInterface[]
     */
    protected $decorators = [];

    /**
     * @var FilterInterface
     */
    protected $filter;

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

    /**
     * Escape value to prevent XSS.
     *
     * @var bool
     */
    protected $autoescape = true;

    /**
     * @param array $options
     */
    public function __construct(array $options = [])
    {
        $this->setDefaultOptions($options);
    }

    /**
     * @param Grid $grid
     * @return $this
     */
    public function setGrid($grid)
    {
        $this->grid = $grid;

        return $this;
    }

    /**
     * @return Grid
     */
    public function getGrid()
    {
        return $this->grid;
    }

    /**
     * @return string
     */
    public function getTitle()
    {
        return $this->title;
    }

    /**
     * @param string $title
     * @return $this
     */
    public function setTitle($title)
    {
        $this->title = $title;

        return $this;
    }

    /**
     * @return string
     */
    public function getName()
    {
        return $this->name;
    }

    /**
     * @param string $name
     * @return $this
     */
    public function setName($name)
    {
        $this->name = $name;

        return $this;
    }

    /**
     * @return boolean
     */
    public function isSortable()
    {
        return $this->sortable;
    }

    /**
     * @param boolean $flag
     * @return $this
     */
    public function setSortable($flag)
    {
        $this->sortable = (bool) $flag;

        return $this;
    }

    /**
     * @param \Closure $closure
     * @return $this
     */
    public function setClickable(\Closure $closure)
    {
        $this->addDecorator((new Link())->render($closure));

        return $this;
    }

    /**
     * @param \Closure $closure
     * @return $this
     */
    public function setRender(\Closure $closure)
    {
        $this->addDecorator((new Html())->render($closure));

        return $this;
    }

    /**
     * @param string $placeholder
     * @return $this
     */
    public function setPlaceholder($placeholder)
    {
        $this->addDecorator(new Placeholder($placeholder));

        return $this;
    }

    /**
     * @param DecoratorInterface $decorator
     * @return $this
     */
    public function addDecorator(DecoratorInterface $decorator)
    {
        $this->decorators[] = $decorator;

        return $this;
    }

    /**
     * @param DecoratorInterface[] $decorators
     * @return $this
     */
    public function setDecorators(array $decorators)
    {
        $this->decorators = $decorators;

        return $this;
    }

    /**
     * @return DecoratorInterface[]
     */
    public function getDecorators()
    {
        return $this->decorators;
    }

    /**
     * @param FilterInterface $filter
     * @return $this
     */
    public function setFilter(FilterInterface $filter)
    {
        $filter->setColumn($this);
        $this->filter = $filter;

        return $this;
    }

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

    /**
     * @return bool
     */
    public function isFilterable()
    {
        return $this->filter !== null;
    }

    /**
     * @return boolean
     */
    public function isAutoescape(): bool
    {
        return $this->autoescape;
    }

    /**
     * @param boolean $flag
     * @return $this
     */
    public function setAutoescape(bool $flag)
    {
        $this->autoescape = $flag;

        return $this;
    }

    /**
     * @param array $options
     */
    protected function setDefaultOptions(array $options)
    {
        if (empty($options['name'])) {
            throw new \InvalidArgumentException(sprintf('Column MUST have name in %s class.', get_class($this)));
        }

        if (empty($options['label'])) {
            $options['label'] = camel_case($options['name']);
        }

        // placeholder MUST be the first element in options array. that's because "placeholder" decorator
        // can break further decorators.
        $placeholder = array_pull($options, 'placeholder');
        if (!empty($placeholder)) {
            $options = array_merge(['placeholder' => $placeholder], $options);
        }

        foreach ($options as $key => $values) {
            $methodName = 'set' . ucfirst(camel_case($key));

            if (method_exists($this, $methodName)) {
                // setDecorators() method can overwrite previously set decorators. we don't want that to happen
                // because user could set other decorators via setRender() or setClickable() method.
                if ($methodName === 'setDecorators') {
                    $values = array_merge($this->decorators, $values);
                }
                $this->$methodName($values);
            }
        }
    }

    /**
     * @param string $name
     * @return mixed
     */
    public function __get($name)
    {
        $name = camel_case($name);

        if (!isset($this->$name)) {
            throw new \InvalidArgumentException(
                sprintf("Field %s does not exist in %s class", $name, get_class($this))
            );
        }

        return $this->$name;
    }
}