Yiisoft\Yii\DataView\Column\CheckboxColumnRenderer

Complexity

Total Complexity

14

Size/Duplication

Total Lines	83
Duplicated Lines	0 %

Test Coverage

Coverage

69.57%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	renderColumn()	0	4	1
A	renderBody()	0	29	5
A	checkColumn()	0	8	2
A	renderHeader()	0	15	3
A	renderFooter()	0	9	2
A	renderFilter()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\DataView\Column;

use InvalidArgumentException;
use Stringable;
use Yiisoft\Html\Html;
use Yiisoft\Yii\DataView\Column\Base\Cell;
use Yiisoft\Yii\DataView\Column\Base\DataContext;
use Yiisoft\Yii\DataView\Column\Base\GlobalContext;

final class CheckboxColumnRenderer implements ColumnRendererInterface
{
    public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
    {
        $this->checkColumn($column);
        return $cell->addAttributes($column->getColumnAttributes());
    }

    public function renderHeader(ColumnInterface $column, Cell $cell, GlobalContext $context): ?Cell
    {
        $this->checkColumn($column);

        $header = $column->getHeader();
        if ($header === null) {
            if (!$column->isMultiple()) {
                return null;
            }
            $header = Html::checkbox('checkbox-selection-all', 1);
        }

        return $cell
            ->addAttributes($column->getHeaderAttributes())
            ->content($header);
    }

    public function renderFilter(ColumnInterface $column, Cell $cell, GlobalContext $context): ?Cell
    {
        return null;
    }

    public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell
    {
        $this->checkColumn($column);

        $inputAttributes = $column->getInputAttributes();
        $name = null;
        $value = null;

        if (!array_key_exists('name', $inputAttributes)) {
            $name = 'checkbox-selection';
        }

        if (!array_key_exists('value', $inputAttributes)) {
            $key = $context->getKey();
            $value = is_array($key)
                ? json_encode($key, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)
                : (string)$key;
        }

        $input = Html::checkbox($name, $value, $inputAttributes);

        $contentClosure = $column->getContent();
        /** @var string|Stringable $content */
        $content = $contentClosure === null ? $input : $contentClosure($input, $context);

        return $cell
            ->addAttributes($column->getBodyAttributes())
            ->content($content)
            ->encode(false);
    }

    public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
    {
        $this->checkColumn($column);

        if ($column->getFooter() !== null) {
            $cell = $cell->content($column->getFooter());
        }

        return $cell;
    }

    /**
     * @psalm-assert CheckboxColumn $column
     */
    private function checkColumn(ColumnInterface $column): void
    {
        if (!$column instanceof CheckboxColumn) {
            throw new InvalidArgumentException(
                sprintf(
                    'Expected "%s", but "%s" given.',
                    CheckboxColumn::class,
                    $column::class
                )
            );
        }
    }
}