columnfields.php

<?php
 
namespace Bitrix\Main\Grid\Column\UI;
 
use Bitrix\Main\ArgumentException;
 
trait ColumnFields
{
    protected string $firstOrder = 'asc';
    protected bool $showname = true;
    protected ?string $align = null;
    protected ?string $title = null;
    protected ?int $width = null;
    protected bool $resizeable = true;
    protected bool $preventDefault = true;
    protected bool $sticked = false;
    protected bool $shift = false;
    protected ?string $sectionId = null;
    protected int $sortIndex = 0;
    protected ?string $sortUrl = null;
    protected ?string $sortState = null;
    protected bool $shown;
    protected ?Icon $icon = null;
    protected ?Hint $hint = null;
    protected Layout $layout;
 
    // css
    protected ?string $cssClassName = null;
    protected ?string $cssColorValue = null;
    protected ?string $cssColorClassName = null;
 
    public function getFirstOrder(): string
    {
        return $this->firstOrder;
    }
 
    public function setFirstOrder(string $firstOrder): self
    {
        $this->firstOrder = $firstOrder === 'asc' ? 'asc' : 'desc';
 
        return $this;
    }
 
    public function isShowname(): bool
    {
        return $this->showname;
    }
 
    public function setShowname(bool $showname): self
    {
        $this->showname = $showname;
 
        return $this;
    }
 
    public function getCssClassName(): ?string
    {
        return $this->cssClassName;
    }
 
    public function setCssClassName(?string $cssClassName): self
    {
        $this->cssClassName = $cssClassName;
 
        return $this;
    }
 
    public function getAlign(): string
    {
        return $this->align ?? 'left';
    }
 
    public function setAlign(?string $align): self
    {
        $this->align = $align;
 
        return $this;
    }
 
    public function getTitle(): ?string
    {
        return $this->title;
    }
 
    public function setTitle(?string $title): self
    {
        $this->title = $title;
 
        return $this;
    }
 
    public function getWidth(): ?int
    {
        return $this->width;
    }
 
    public function setWidth(?int $width): self
    {
        $this->width = $width;
 
        return $this;
    }
 
    public function getCssColorClassName(): ?string
    {
        return $this->cssColorClassName;
    }
 
    public function setCssColorClassName(string $color): self
    {
        $this->cssColorClassName = $color;
 
        return $this;
    }
 
    public static function isValidCssColorValue(string $value): bool
    {
        return
            strpos($value, '#') === 0
            || strpos($value, 'rgb') === 0
            || strpos($value, 'hsl') === 0
        ;
    }
 
    public function setCssColorValue(string $value): self
    {
        if (!self::isValidCssColorValue($value))
        {
            throw new ArgumentException('Invalid css color value');
        }
 
        $this->cssColorValue = $value;
 
        return $this;
    }
 
    public function getCssColorValue(): ?string
    {
        return $this->cssColorValue;
    }
 
    public function isResizeable(): bool
    {
        return $this->resizeable !== false;
    }
 
    public function setResizeable(bool $resizeable): self
    {
        $this->resizeable = $resizeable;
 
        return $this;
    }
 
    public function isPreventDefault(): bool
    {
        return $this->preventDefault ?? true;
    }
 
    public function setPreventDefault(bool $preventDefault): self
    {
        $this->preventDefault = $preventDefault;
 
        return $this;
    }
 
    public function isShift(): bool
    {
        return $this->shift;
    }
 
    public function setShift(bool $shift): self
    {
        $this->shift = $shift;
 
        return $this;
    }
 
    public function isSticked(): bool
    {
        return $this->sticked;
    }
 
    public function setSticked(bool $sticked): self
    {
        $this->sticked = $sticked;
 
        return $this;
    }
 
    public function setSection(?string $value): self
    {
        $this->sectionId = $value;
 
        return $this;
    }
 
    public function getSection(): ?string
    {
        return $this->sectionId;
    }
 
    public function setSortIndex(int $value): self
    {
        $this->sortIndex = $value;
 
        return $this;
    }
 
    public function getSortIndex(): int
    {
        return $this->sortIndex;
    }
 
    public function setSortState(string $value): self
    {
        $this->sortState = $value === 'asc' ? 'asc' : 'desc';
 
        return $this;
    }
 
    public function getSortState(): ?string
    {
        return $this->sortState;
    }
 
    public function setSortUrl(string $value): self
    {
        $this->sortUrl = $value;
 
        return $this;
    }
 
    public function getSortUrl(): ?string
    {
        return $this->sortUrl;
    }
 
    public function getSortOrder(): string
    {
        return $this->getSortState() === 'desc' ? 'desc' : 'asc';
    }
 
    public function getNextSortOrder(): string
    {
        $sortState = $this->getSortState();
        if (isset($sortState))
        {
            return $sortState === 'asc' ? 'desc' : 'asc';
        }
 
        return $this->getFirstOrder();
    }
 
    public function setShown(bool $value): self
    {
        $this->shown = $value;
 
        return $this;
    }
 
    abstract public function isDefault(): bool;
 
    public function isShown(): bool
    {
        return $this->shown ?? $this->isDefault();
    }
 
    public function getLayout(): Layout
    {
        $this->layout ??= new Layout($this);
 
        return $this->layout;
    }
 
    public function setIcon(?Icon $value): self
    {
        $this->icon = $value;
 
        return $this;
    }
 
    public function getIcon(): ?Icon
    {
        return $this->icon;
    }
 
    public function setHint(?Hint $value): self
    {
        $this->hint = $value;
 
        return $this;
    }
 
    public function getHint(): ?Hint
    {
        return $this->hint;
    }
}