Replace checkColumn() methods in column renderers to generic (#238)

yiisoft · Jan 22, 2025 · 738e585 · 738e585
1 parent b305e70
commit 738e585
Show file tree

Hide file tree

Showing 8 changed files with 48 additions and 118 deletions.
diff --git a/src/Column/ActionColumnRenderer.php b/src/Column/ActionColumnRenderer.php
@@ -5,14 +5,18 @@
 namespace Yiisoft\Yii\DataView\Column;
 
 use Closure;
-use InvalidArgumentException;
 use Yiisoft\Html\Html;
 use Yiisoft\Yii\DataView\Column\Base\Cell;
 use Yiisoft\Yii\DataView\Column\Base\GlobalContext;
 use Yiisoft\Yii\DataView\Column\Base\DataContext;
 use Yiisoft\Yii\DataView\Column\Base\HeaderContext;
 
+use function is_bool;
+use function is_callable;
+
 /**
+ * @implements ColumnRendererInterface<ActionColumn>
+ *
  * @psalm-import-type UrlCreator from ActionColumn
  * @psalm-import-type ButtonRenderer from ActionColumn
  */
@@ -53,22 +57,18 @@ public function __construct(
 
     public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
         return $cell->addAttributes($column->columnAttributes);
     }
 
     public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext $context): Cell
     {
-        $this->checkColumn($column);
         return $cell
             ->content($column->header ?? $context->translate('Actions'))
             ->addAttributes($column->headerAttributes);
     }
 
     public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell
     {
-        $this->checkColumn($column);
-
         $contentSource = $column->content;
 
         if ($contentSource !== null) {
@@ -114,8 +114,6 @@ function (array $matches) use ($column, $buttons, $context): string {
 
     public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
-
         if ($column->footer !== null) {
             $cell = $cell->content($column->footer);
         }
@@ -238,20 +236,4 @@ private function getTemplate(ActionColumn $column, array $buttons): string
 
         return implode("\n", $tokens);
     }
-
-    /**
-     * @psalm-assert ActionColumn $column
-     */
-    private function checkColumn(ColumnInterface $column): void
-    {
-        if (!$column instanceof ActionColumn) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Expected "%s", but "%s" given.',
-                    self::class,
-                    $column::class
-                )
-            );
-        }
-    }
 }
diff --git a/src/Column/CheckboxColumnRenderer.php b/src/Column/CheckboxColumnRenderer.php
@@ -4,26 +4,25 @@
 
 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;
 use Yiisoft\Yii\DataView\Column\Base\HeaderContext;
 
+/**
+ * @implements ColumnRendererInterface<CheckboxColumn>
+ */
 final class CheckboxColumnRenderer implements ColumnRendererInterface
 {
     public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
         return $cell->addAttributes($column->columnAttributes);
     }
 
     public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext $context): ?Cell
     {
-        $this->checkColumn($column);
-
         $header = $column->header;
         if ($header === null) {
             if (!$column->multiple) {
@@ -39,8 +38,6 @@ public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext
 
     public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell
     {
-        $this->checkColumn($column);
-
         $inputAttributes = $column->inputAttributes;
         $name = null;
         $value = null;
@@ -67,28 +64,10 @@ public function renderBody(ColumnInterface $column, Cell $cell, DataContext $con
 
     public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
-
         if ($column->footer !== null) {
             $cell = $cell->content($column->footer);
         }
 
         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
-                )
-            );
-        }
-    }
 }
diff --git a/src/Column/ColumnRendererInterface.php b/src/Column/ColumnRendererInterface.php
@@ -11,14 +11,28 @@
 
 /**
  * An interface for column renderers that implement {@see ColumnInterface}.
+ *
+ * @template TColumn as ColumnInterface
  */
 interface ColumnRendererInterface
 {
+    /**
+     * @psalm-param TColumn $column
+     */
     public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell;
 
+    /**
+     * @psalm-param TColumn $column
+     */
     public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext $context): ?Cell;
 
+    /**
+     * @psalm-param TColumn $column
+     */
     public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell;
 
+    /**
+     * @psalm-param TColumn $column
+     */
     public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell;
 }
diff --git a/src/Column/DataColumnRenderer.php b/src/Column/DataColumnRenderer.php
@@ -5,7 +5,6 @@
 namespace Yiisoft\Yii\DataView\Column;
 
 use DateTimeInterface;
-use InvalidArgumentException;
 use Psr\Container\ContainerInterface;
 use Yiisoft\Arrays\ArrayHelper;
 use Yiisoft\Data\Reader\FilterInterface;
@@ -31,6 +30,10 @@
 use function is_string;
 
 /**
+ * @template TColumn as DataColumn
+ * @implements FilterableColumnRendererInterface<TColumn>
+ * @implements SortableColumnInterface<TColumn>
+ *
  * @psalm-import-type FilterEmptyCallable from DataColumn
  */
 final class DataColumnRenderer implements FilterableColumnRendererInterface, SortableColumnInterface
@@ -57,7 +60,6 @@ public function __construct(
 
     public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         return $cell
@@ -67,7 +69,6 @@ public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext
 
     public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext $context): Cell
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         $cell = $cell
@@ -96,7 +97,6 @@ public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext
 
     public function renderFilter(ColumnInterface $column, Cell $cell, FilterContext $context): ?Cell
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         if ($column->property === null || $column->filter === false) {
@@ -133,7 +133,6 @@ public function renderFilter(ColumnInterface $column, Cell $cell, FilterContext
 
     public function makeFilter(ColumnInterface $column, MakeFilterContext $context): ?FilterInterface
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         if ($column->property === null) {
@@ -181,7 +180,6 @@ public function makeFilter(ColumnInterface $column, MakeFilterContext $context):
 
     public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         $contentSource = $column->content;
@@ -215,7 +213,6 @@ public function renderBody(ColumnInterface $column, Cell $cell, DataContext $con
 
     public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         if ($column->footer !== null) {
@@ -255,25 +252,8 @@ private function castToString(mixed $value, DataColumn $column): string
         return (string) $value;
     }
 
-    /**
-     * @psalm-assert DataColumn $column
-     */
-    private function checkColumn(ColumnInterface $column): void
-    {
-        if (!$column instanceof DataColumn) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Expected "%s", but "%s" given.',
-                    DataColumn::class,
-                    $column::class
-                )
-            );
-        }
-    }
-
     public function getOrderProperties(ColumnInterface $column): array
     {
-        $this->checkColumn($column);
         /** @var DataColumn $column This annotation is for IDE only */
 
         if ($column->property === null) {

diff --git a/src/Column/FilterableColumnRendererInterface.php b/src/Column/FilterableColumnRendererInterface.php
@@ -10,12 +10,21 @@
 use Yiisoft\Yii\DataView\Column\Base\MakeFilterContext;
 use Yiisoft\Yii\DataView\Filter\Factory\IncorrectValueException;
 
+/**
+ * @template TColumn as ColumnInterface
+ * @extends ColumnRendererInterface<TColumn>
+ */
 interface FilterableColumnRendererInterface extends ColumnRendererInterface
 {
+    /**
+     * @psalm-param TColumn $column
+     */
     public function renderFilter(ColumnInterface $column, Cell $cell, FilterContext $context): ?Cell;
 
     /**
      * @throws IncorrectValueException
+     *
+     * @psalm-param TColumn $column
      */
     public function makeFilter(ColumnInterface $column, MakeFilterContext $context): ?FilterInterface;
 }
diff --git a/src/Column/RadioColumnRenderer.php b/src/Column/RadioColumnRenderer.php
@@ -4,26 +4,27 @@
 
 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;
 use Yiisoft\Yii\DataView\Column\Base\HeaderContext;
 
+use function array_key_exists;
+
+/**
+ * @implements ColumnRendererInterface<RadioColumn>
+ */
 final class RadioColumnRenderer implements ColumnRendererInterface
 {
     public function renderColumn(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
         return $cell->addAttributes($column->columnAttributes);
     }
 
     public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext $context): ?Cell
     {
-        $this->checkColumn($column);
-
         $header = $column->header;
         if ($header === null) {
             return null;
@@ -36,8 +37,6 @@ public function renderHeader(ColumnInterface $column, Cell $cell, HeaderContext
 
     public function renderBody(ColumnInterface $column, Cell $cell, DataContext $context): Cell
     {
-        $this->checkColumn($column);
-
         $inputAttributes = $column->inputAttributes;
         $name = null;
         $value = null;
@@ -64,28 +63,10 @@ public function renderBody(ColumnInterface $column, Cell $cell, DataContext $con
 
     public function renderFooter(ColumnInterface $column, Cell $cell, GlobalContext $context): Cell
     {
-        $this->checkColumn($column);
-
         if ($column->footer !== null) {
             $cell = $cell->content($column->footer);
         }
 
         return $cell;
     }
-
-    /**
-     * @psalm-assert RadioColumn $column
-     */
-    private function checkColumn(ColumnInterface $column): void
-    {
-        if (!$column instanceof RadioColumn) {
-            throw new InvalidArgumentException(
-                sprintf(
-                    'Expected "%s", but "%s" given.',
-                    RadioColumn::class,
-                    $column::class
-                )
-            );
-        }
-    }
 }