ZfcDatagrid\Column\AbstractColumn

Complexity

Total Complexity

71

Size/Duplication

Total Lines	640
Duplicated Lines	0 %

Coupling/Cohesion

Components	10
Dependencies	3

Importance

Changes

0

55 Methods

Rating	Name	Duplication	Size	Complexity
A	setLabel()	0	4	1
A	getLabel()	0	4	1
A	setUniqueId()	0	4	1
A	getUniqueId()	0	4	1
A	setWidth()	0	4	1
A	getWidth()	0	4	1
A	setHidden()	0	4	1
A	isHidden()	0	4	1
A	setIdentity()	0	7	1
A	isIdentity()	0	4	1
A	setType()	0	9	3
A	getType()	0	8	2
A	setStyles()	0	8	2
A	addStyle()	0	4	1
A	getStyles()	0	4	1
A	hasStyles()	0	8	2
A	setUserSortDisabled()	0	4	1
A	isUserSortEnabled()	0	4	1
A	setSortDefault()	0	7	1
A	getSortDefault()	0	4	1
A	hasSortDefault()	0	8	2
A	setSortActive()	0	4	1
A	isSortActive()	0	8	2
A	getSortActiveDirection()	0	4	1
A	setUserFilterDisabled()	0	4	1
A	setFilterDefaultValue()	0	6	2
A	getFilterDefaultValue()	0	4	1
A	hasFilterDefaultValue()	0	8	2
A	setFilterDefaultOperation()	0	4	1
A	getFilterDefaultOperation()	0	8	2
A	setFilterSelectOptions()	0	12	2
A	unsetFilterSelectOptions()	0	4	1
A	getFilterSelectOptions()	0	4	1
A	hasFilterSelectOptions()	0	8	2
A	setFilterActive()	0	5	1
A	isFilterActive()	0	4	1
A	getFilterActiveValue()	0	4	1
A	isUserFilterEnabled()	0	4	1
A	setTranslationEnabled()	0	4	1
A	isTranslationEnabled()	0	4	1
A	setReplaceValues()	0	8	1
A	hasReplaceValues()	0	4	2
A	getReplaceValues()	0	4	1
A	notReplacedGetEmpty()	0	4	1
A	setRendererParameter()	0	11	2
A	getRendererParameters()	0	8	2
A	setFormatters()	0	4	1
A	setFormatter()	0	6	1
A	addFormatter()	0	4	1
A	getFormatters()	0	4	1
A	getFormatter()	0	6	1
A	hasFormatters()	0	8	2
A	hasFormatter()	0	6	1
A	setRowClickDisabled()	0	4	1
A	isRowClickEnabled()	0	4	1

<?php

namespace ZfcDatagrid\Column;

use ZfcDatagrid\Column\Formatter\AbstractFormatter;
use ZfcDatagrid\Filter;

abstract class AbstractColumn
{
    protected $label = '';

    protected $uniqueId;

    /**
     * @var Type\AbstractType
     */
    protected $type = null;

    protected $styles = [];

    protected $width = 5;

    protected $isHidden = false;

    protected $isIdentity = false;

    protected $userSortEnabled = true;

    protected $sortDefault = [];

    protected $sortActive = null;

    protected $filterDefaultValue = null;

    protected $filterDefaultOperation = null;

    /**
     * @var null array
     */
    protected $filterSelectOptions;

    protected $filterActive = null;

    protected $filterActiveValue = '';

    protected $userFilterEnabled = true;

    protected $translationEnabled = false;

    protected $replaceValues = [];

    protected $notReplacedGetEmpty = true;

    protected $rowClickEnabled = true;

    protected $rendererParameter = [];

    /**
     * @var AbstractFormatter[]
     */
    protected $formatters = [];

    /**
     * @param $name
     */
    public function setLabel($name)
    {
        $this->label = (string) $name;
    }

    /**
     * Get the label.
     *
     * @return string null
     */
    public function getLabel()
    {
        return $this->label;
    }

    /**
     * @param $id
     */
    public function setUniqueId($id)
    {
        $this->uniqueId = $id;
    }

    /**
     * @return mixed
     */
    public function getUniqueId()
    {
        return $this->uniqueId;
    }

    /**
     * Set the width in "percent"
     * It will be calculated to 100% dependend on what is displayed
     * If it's a different output mode like Excel it's dependend on the papersize/orientation.
     *
     * @param number $percent
     */
    public function setWidth($percent)
    {
        $this->width = (float) $percent;

The property $width was declared of type integer, but (double) $percent is of type double. Maybe add a type cast?

    }

    /**
     * Get the width.
     *
     * @return number
     */
    public function getWidth()
    {
        return $this->width;
    }

    /**
     * Hide or show the column.
     *
     * @param bool $mode
     */
    public function setHidden($mode = true)
    {
        $this->isHidden = (bool) $mode;
    }

    /**
     * Is this column hidden?
     *
     * @return bool
     */
    public function isHidden()
    {
        return (bool) $this->isHidden;
    }

    /**
     * Set this column as primaryKey column.
     *
     * @param bool $mode
     */
    public function setIdentity($mode = true)
    {
        $this->isIdentity = (bool) $mode;

        // Because IDs are normally hidden
        $this->setHidden($mode);
    }

    /**
     * Is this a primaryKey column?
     *
     * @return bool
     */
    public function isIdentity()
    {
        return (bool) $this->isIdentity;
    }

    /**
     * Set the column type.
     *
     * @param Type\AbstractType $type
     */
    public function setType(Type\AbstractType $type)
    {
        if ($type instanceof Type\Image && $this->hasFormatters() === false) {
            $this->addFormatter(new Formatter\Image());
            $this->setRowClickDisabled(true);
        }

        $this->type = $type;
    }

    /**
     * @return Type\AbstractType
     */
    public function getType()
    {
        if (null === $this->type) {
            $this->type = new Type\PhpString();
        }

        return $this->type;
    }

    /**
     * Set styles.
     *
     * @param array $styles
     */
    public function setStyles(array $styles)
    {
        $this->styles = [];

        foreach ($styles as $style) {
            $this->addStyle($style);
        }
    }

    /**
     * @param Style\AbstractStyle $style
     */
    public function addStyle(Style\AbstractStyle $style)
    {
        $this->styles[] = $style;
    }

    /**
     * @return Style\AbstractStyle[]
     */
    public function getStyles()
    {
        return $this->styles;
    }

    /**
     * @return bool
     */
    public function hasStyles()
    {
        if (count($this->styles) > 0) {
            return true;
        }

        return false;
    }

    /**
     * Is the user allowed to do sort on this column?
     *
     * @param bool $mode
     */
    public function setUserSortDisabled($mode = true)
    {
        $this->userSortEnabled = (bool) !$mode;
    }

    /**
     * Is user sort enabled?
     *
     * @return bool
     */
    public function isUserSortEnabled()
    {
        return (bool) $this->userSortEnabled;
    }

    /**
     * The data will get sorted by this column (by default)
     * If will be changed by the user per request (POST,GET....).
     *
     * @param int    $priority
     * @param string $direction
     */
    public function setSortDefault($priority = 1, $direction = 'ASC')
    {
        $this->sortDefault = [
            'priority' => $priority,
            'sortDirection' => $direction,
        ];
    }

    /**
     * Get the sort defaults.
     *
     * @return array
     */
    public function getSortDefault()
    {
        return $this->sortDefault;
    }

    /**
     * Does this column has sort defaults?
     *
     * @return bool
     */
    public function hasSortDefault()
    {
        if (count($this->sortDefault) > 0) {
            return true;
        }

        return false;
    }

    /**
     * Set that the data is getting sorted by this columns.
     *
     * @param string $direction
     */
    public function setSortActive($direction = 'ASC')
    {
        $this->sortActive = $direction;
    }

    /**
     * @return bool
     */
    public function isSortActive()
    {
        if ($this->sortActive !== null) {
            return true;
        }

        return false;
    }

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

    /**
     * @param bool $mode
     */
    public function setUserFilterDisabled($mode = true)
    {
        $this->userFilterEnabled = (bool) !$mode;
    }

    /**
     * Set the default filterung value (used as long no user filtering getting applied)
     * Examples
     * $grid->setFilterDefaultValue('something');
     * $grid->setFilterDefaultValue('>20');.
     *
     * OPERATORS are ALLOWED (like for the user)
     *
     * @param string $value
     */
    public function setFilterDefaultValue($value = null)
    {
        if ($value != '') {
            $this->filterDefaultValue = (string) $value;
        }
    }

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

    /**
     * @return bool
     */
    public function hasFilterDefaultValue()
    {
        if ($this->filterDefaultValue != '') {
            return true;
        } else {
            return false;
        }
    }

    /**
     * @param string $operation
     */
    public function setFilterDefaultOperation($operation = Filter::LIKE)
    {
        $this->filterDefaultOperation = $operation;
    }

    /**
     * @return string
     */
    public function getFilterDefaultOperation()
    {
        if ($this->filterDefaultOperation != '') {
            return $this->filterDefaultOperation;
        }

        return $this->getType()->getFilterDefaultOperation();
    }

    /**
     * @param array $options
     * @param bool  $noSelect
     */
    public function setFilterSelectOptions(array $options = null, $noSelect = true)
    {
        // This work also with options with integer based array index such as
        // array(0 => 'zero', 1 => 'once', 2 => 'double', 3 => 'triple'....)

60% of this comment could be valid code. Did you maybe forget this after debugging?

        if (true === $noSelect) {
            $options = ['' => '-'] + $options;
            $this->setFilterDefaultValue('');
        }

        $this->filterSelectOptions = $options;
    }

    /**
     * Unset the filter select options (normal search).
     */
    public function unsetFilterSelectOptions()
    {
        $this->filterSelectOptions = null;
    }

    /**
     * @return array null
     */
    public function getFilterSelectOptions()
    {
        return $this->filterSelectOptions;
    }

    /**
     * @return bool
     */
    public function hasFilterSelectOptions()
    {
        if (is_array($this->filterSelectOptions)) {
            return true;
        }

        return false;
    }

    /**
     * @param mixed $value
     */
    public function setFilterActive($value = '')
    {
        $this->filterActive = (bool) true;
        $this->filterActiveValue = $value;
    }

    /**
     * @return bool
     */
    public function isFilterActive()
    {
        return $this->filterActive;
    }

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

    /**
     * @return bool
     */
    public function isUserFilterEnabled()
    {
        return (bool) $this->userFilterEnabled;
    }

    /**
     * Enable data translation.
     *
     * @param bool $mode
     */
    public function setTranslationEnabled($mode = true)
    {
        $this->translationEnabled = (bool) $mode;
    }

    /**
     * Is data translation enabled?
     *
     * @return bool
     */
    public function isTranslationEnabled()
    {
        return (bool) $this->translationEnabled;
    }

    /**
     * Replace the column values with the applied values.
     *
     * @param array $values
     * @param bool  $notReplacedGetEmpty
     */
    public function setReplaceValues(array $values, $notReplacedGetEmpty = true)
    {
        $this->replaceValues = $values;
        $this->notReplacedGetEmpty = (bool) $notReplacedGetEmpty;

        $this->setFilterDefaultOperation(Filter::EQUAL);
        $this->setFilterSelectOptions($values);
    }

    /**
     * @return bool
     */
    public function hasReplaceValues()
    {
        return $this->replaceValues ? true : false;
    }

    /**
     * @return array
     */
    public function getReplaceValues()
    {
        return $this->replaceValues;
    }

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

    /**
     * Set parameter for a specific renderer (currently only supported for jqGrid).
     *
     * @param string $name
     * @param mixed  $value
     * @param string $rendererType
     */
    public function setRendererParameter($name, $value, $rendererType = 'jqGrid')
    {
        if (!isset($this->rendererParameter[$rendererType])) {
            $this->rendererParameter[$rendererType] = [];
        }

        $parameters = $this->rendererParameter[$rendererType];
        $parameters[$name] = $value;

        $this->rendererParameter[$rendererType] = $parameters;
    }

    /**
     * @param string $rendererName
     *
     * @return array
     */
    public function getRendererParameters($rendererName = 'jqGrid')
    {
        if (!isset($this->rendererParameter[$rendererName])) {
            $this->rendererParameter[$rendererName] = [];
        }

        return $this->rendererParameter[$rendererName];
    }

    /**
     * Set a template formatter and overwrite other formatter.
     *
     * @param AbstractFormatter[] $formatters
     */
    public function setFormatters(array $formatters)
    {
        $this->formatters = $formatters;
    }

    /**
     * Set a template formatter and overwrite other formatter.
     *
     * @param AbstractFormatter $formatter
     *
     * @deprecated please use setFormatters
     */
    public function setFormatter(AbstractFormatter $formatter)
    {
        trigger_error('Please use setFormatters()', E_USER_DEPRECATED);

        $this->setFormatters([$formatter]);
    }

    /**
     * add a template formatter in the list.
     *
     * @param AbstractFormatter $formatter
     */
    public function addFormatter(AbstractFormatter $formatter)
    {
        $this->formatters[] = $formatter;
    }

    /**
     * return a list of different formatter.
     *
     * @return AbstractFormatter[]
     */
    public function getFormatters()
    {
        return $this->formatters;
    }

    /**
     * return a list of different formatter.
     *
     * @return AbstractFormatter[]
     *
     * @deprecated please use getFormatters
     */
    public function getFormatter()
    {
        trigger_error('Please use getFormatters()', E_USER_DEPRECATED);

        return $this->getFormatters();
    }

    /**
     * @return bool
     */
    public function hasFormatters()
    {
        if (count($this->formatters) > 0) {
            return true;
        }

        return false;
    }

    public function hasFormatter()
    {
        trigger_error('Please use hasFormatters()', E_USER_DEPRECATED);

        return $this->hasFormatters();
    }

    /**
     * @param bool $mode
     */
    public function setRowClickDisabled($mode = true)
    {
        $this->rowClickEnabled = (bool) !$mode;
    }

    /**
     * @return bool
     */
    public function isRowClickEnabled()
    {
        return $this->rowClickEnabled;
    }
}