Grido\Components\Columns\Column

Complexity

Total Complexity

50

Size/Duplication

Total Lines	383
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

96.77%

Importance

Changes	4
Bugs	0	Features	0

29 Methods

Rating	Name	Duplication	Size	Complexity
A	getCellPrototype()	0	16	4
A	getColumn()	0	4	2
A	getSort()	0	14	4
A	getCustomRender()	0	4	1
A	getCustomRenderVariables()	0	4	1
A	isSortable()	0	4	1
A	setFilterText()	0	4	1
A	setFilterDate()	0	4	1
A	setFilterDateRange()	0	4	1
A	setFilterCheck()	0	4	1
A	setFilterSelect()	0	4	1
A	setFilterNumber()	0	4	1
A	setFilterCustom()	0	4	1
A	__construct()	0	7	1
A	setSortable()	0	5	1
A	setReplacement()	0	5	1
A	setColumn()	0	5	1
A	setDefaultSort()	0	5	1
A	setCustomRender()	0	7	1
A	setCustomRenderExport()	0	5	1
A	setCellCallback()	0	5	1
B	getHeaderPrototype()	0	15	5
A	renderExport()	0	9	2
A	formatValue()	0	8	2
A	getLabel()	0	6	2
A	hasFilter()	0	4	1
A	render()	0	9	2
A	getValue()	0	13	3
B	applyReplacement()	0	8	5

<?php

/**
 * This file is part of the Grido (http://grido.bugyik.cz)
 *
 * Copyright (c) 2011 Petr Bugyík (http://petr.bugyik.cz)
 *
 * For the full copyright and license information, please view
 * the file LICENSE.md that was distributed with this source code.
 */

namespace Grido\Components\Columns;

use Grido\Helpers;
use Grido\Exception;

/**
 * Column grid.
 *
 * @package     Grido
 * @subpackage  Components\Columns
 * @author      Petr Bugyík
 *
 * @property-read string $sort
 * @property-read \Nette\Utils\Html $cellPrototype
 * @property-read \Nette\Utils\Html $headerPrototype
 * @property-write callback $cellCallback
 * @property-write string $defaultSorting
 * @property-write mixed $customRender
 * @property-write array $customRenderVariables
 * @property-write mixed $customRenderExport
 * @property-write array $replacements
 * @property-write bool $sortable
 * @property string $column
 */
abstract class Column extends \Grido\Components\Component
{
    const ID = 'columns';

    const VALUE_IDENTIFIER = '%value';

    const ORDER_ASC = 'asc';
    const ORDER_DESC = 'desc';

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

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

    /** @var \Nette\Utils\Html <td> html tag */
    protected $cellPrototype;

    /** @var callback returns td html element; function($row, Html $td) */
    protected $cellCallback;

    /** @var \Nette\Utils\Html <th> html tag */
    protected $headerPrototype;

    /** @var mixed custom rendering */
    protected $customRender;

    /** @var array custom rendering template variables */
    protected $customRenderVariables = [];

    /** @var mixed custom export rendering */
    protected $customRenderExport;

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

    /** @var array of arrays('pattern' => 'replacement') */
    protected $replacements = [];

    /**
     * @param \Grido\Grid $grid
     * @param string $name
     * @param string $label
     */
    public function __construct($grid, $name, $label)
    {
        $this->addComponentToGrid($grid, Helpers::formatColumnName($name));

        $this->type = get_class($this);
        $this->label = $label;
    }

    /**
     * @param bool $sortable
     * @return Column
     */
    public function setSortable($sortable = TRUE)
    {
        $this->sortable = (bool) $sortable;
        return $this;
    }

    /**
     * @param array $replacement array('pattern' => 'replacement')
     * @return Column
     */
    public function setReplacement(array $replacement)
    {
        $this->replacements = $this->replacements + $replacement;
        return $this;
    }

    /**
     * @param mixed $column
     * @return Column
     */
    public function setColumn($column)
    {
        $this->column = $column;
        return $this;
    }

    /**
     * @param string $dir
     * @return Column
     */
    public function setDefaultSort($dir)
    {
        $this->grid->setDefaultSort([$this->getName() => $dir]);
        return $this;
    }

    /**
     * @param mixed $callback callback or string for name of template filename
     * @param array $variables - template variables
     * @return Column
     */
    public function setCustomRender($callback, $variables = [])
    {
        $this->customRender = $callback;
        $this->customRenderVariables = $variables;

        return $this;
    }

    /**
     * @param mixed $callback |
     * @return Column
     */
    public function setCustomRenderExport($callback)
    {
        $this->customRenderExport = $callback;
        return $this;
    }

    /**
     * @param callback $callback
     * @return Column
     */
    public function setCellCallback($callback)
    {
        $this->cellCallback = $callback;
        return $this;
    }

    /**********************************************************************************************/

    /**
     * Returns cell prototype (<td> html tag).
     * @param mixed $row
     * @return \Nette\Utils\Html
     */
    public function getCellPrototype($row = NULL)
    {
        $td = $this->cellPrototype;

        if ($td === NULL) { //cache
            $td = $this->cellPrototype = \Nette\Utils\Html::el('td')
                ->setClass(['grid-cell-' . $this->getName()]);
        }

        if ($this->cellCallback && $row !== NULL) {
            $td = clone $td;
            $td = call_user_func_array($this->cellCallback, [$row, $td]);
        }

        return $td;
    }

    /**
     * Returns header cell prototype (<th> html tag).
     * @return \Nette\Utils\Html
     */
    public function getHeaderPrototype()
    {
        if ($this->headerPrototype === NULL) {
            $this->headerPrototype = \Nette\Utils\Html::el('th')
                ->setClass(['column', 'grid-header-' . $this->getName()]);
        }

        if ($this->isSortable() && $this->getSort()) {
            $this->headerPrototype->class[] = $this->getSort() == self::ORDER_DESC
                ? 'desc'
                : 'asc';
        }

        return $this->headerPrototype;
    }

    /**
     * @return mixed
     * @internal
     */
    public function getColumn()
    {
        return $this->column ? $this->column : $this->getName();
    }

    /**
     * @return string
     * @internal
     */
    public function getSort()
    {
        if ($this->sort === NULL) {
            $name = $this->getName();

            $sort = isset($this->grid->sort[$name])
                ? $this->grid->sort[$name]
                : NULL;

            $this->sort = $sort === NULL ? NULL : $sort;
        }

        return $this->sort;
    }

    /**
     * @return mixed
     * @internal
     */
    public function getCustomRender()
    {
        return $this->customRender;
    }

    /**
     * @return array
     * @internal
     */
    public function getCustomRenderVariables()
    {
        return $this->customRenderVariables;
    }

    /**
     * @return mixed
     * @internal
     */
    public function getLabel()
    {
        return is_string($this->label)
            ? $this->translate($this->label)
            : $this->label;
    }

    /**********************************************************************************************/

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

    /**
     * @return bool
     * @internal
     */
    public function hasFilter()
    {
        return (bool) $this->grid->getFilter($this->getName(), FALSE);
    }

    /**********************************************************************************************/

    /**
     * @param mixed $row
     * @return string
     * @internal
     */
    public function render($row)
    {
        if (is_callable($this->customRender)) {
            return call_user_func_array($this->customRender, [$row]);
        }

        $value = $this->getValue($row);
        return $this->formatValue($value);
    }

    /**
     * @param mixed $row
     * @return string
     * @internal
     */
    public function renderExport($row)
    {
        if (is_callable($this->customRenderExport)) {
            return call_user_func_array($this->customRenderExport, [$row]);
        }

        $value = $this->getValue($row);
        return strip_tags($this->applyReplacement($value));
    }

    /**
     * @param mixed $row
     * @throws Exception
     * @return mixed
     */
    protected function getValue($row)
    {
        $column = $this->getColumn();
        if (is_string($column)) {
            return $this->grid->getProperty($row, Helpers::unformatColumnName($column));

        } elseif (is_callable($column)) {
            return call_user_func_array($column, [$row]);

        } else {
            throw new Exception('Column must be string or callback.');
        }
    }

    /**
     * @param mixed $value
     * @return mixed
     */
    protected function applyReplacement($value)
    {
        return (is_scalar($value) || $value === NULL) && isset($this->replacements[$value])
            ? is_string($value)
                ? str_replace(static::VALUE_IDENTIFIER, $value, $this->replacements[$value])
                : $this->replacements[$value]
            : $value;
    }

    /**
     * @param mixed $value
     * @return mixed
     */
    protected function formatValue($value)
    {
        $value = is_string($value)
            ? \Latte\Runtime\Filters::escapeHtml($value)
            : $value;

        return $this->applyReplacement($value);
    }

    /******************************* Aliases for filters ******************************************/

    /**
     * @return \Grido\Components\Filters\Text
     */
    public function setFilterText()
    {
        return $this->grid->addFilterText($this->getName(), $this->label);
    }

    /**
     * @return \Grido\Components\Filters\Date
     */
    public function setFilterDate()
    {
        return $this->grid->addFilterDate($this->getName(), $this->label);
    }

    /**
     * @return \Grido\Components\Filters\DateRange
     */
    public function setFilterDateRange()
    {
        return $this->grid->addFilterDateRange($this->getName(), $this->label);
    }

    /**
     * @return \Grido\Components\Filters\Check
     */
    public function setFilterCheck()
    {
        return $this->grid->addFilterCheck($this->getName(), $this->label);
    }

    /**
     * @param array $items
     * @return \Grido\Components\Filters\Select
     */
    public function setFilterSelect(array $items = NULL)
    {
        return $this->grid->addFilterSelect($this->getName(), $this->label, $items);
    }

    /**
     * @return \Grido\Components\Filters\Number
     */
    public function setFilterNumber()
    {
        return $this->grid->addFilterNumber($this->getName(), $this->label);
    }

    /**
     * @param \Nette\Forms\IControl $formControl
     * @return \Grido\Components\Filters\Custom
     */
    public function setFilterCustom(\Nette\Forms\IControl $formControl)
    {
        return $this->grid->addFilterCustom($this->getName(), $formControl);
    }
}