Apply more code quality improvements

omines · Oct 25, 2023 · 521cea4 · 521cea4
1 parent 72263d8
commit 521cea4
Show file tree

Hide file tree

Showing 14 changed files with 102 additions and 169 deletions.
diff --git a/src/Adapter/AdapterQuery.php b/src/Adapter/AdapterQuery.php
@@ -62,7 +62,7 @@ public function getTotalRows()
      * @param int|null $totalRows
      * @return $this
      */
-    public function setTotalRows($totalRows): self
+    public function setTotalRows($totalRows): static
     {
         $this->totalRows = $totalRows;
 
@@ -81,7 +81,7 @@ public function getFilteredRows()
      * @param int|null $filteredRows
      * @return $this
      */
-    public function setFilteredRows($filteredRows): self
+    public function setFilteredRows($filteredRows): static
     {
         $this->filteredRows = $filteredRows;
 
@@ -100,7 +100,7 @@ public function getIdentifierPropertyPath()
      * @param string|null $identifierPropertyPath
      * @return $this
      */
-    public function setIdentifierPropertyPath($identifierPropertyPath): self
+    public function setIdentifierPropertyPath($identifierPropertyPath): static
     {
         $this->identifierPropertyPath = $identifierPropertyPath;
 

diff --git a/src/Column/AbstractColumn.php b/src/Column/AbstractColumn.php
@@ -25,21 +25,19 @@
 abstract class AbstractColumn
 {
     /** @var array<string, OptionsResolver> */
-    private static $resolversByClass = [];
+    private static array $resolversByClass = [];
 
-    /** @var string */
-    private $name;
-
-    /** @var int */
-    private $index;
-
-    /** @var DataTable */
-    private $dataTable;
+    private string $name;
+    private int $index;
+    private DataTable $dataTable;
 
     /** @var array<string, mixed> */
-    protected $options;
+    protected array $options;
 
-    public function initialize(string $name, int $index, array $options, DataTable $dataTable)
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function initialize(string $name, int $index, array $options, DataTable $dataTable): void
     {
         $this->name = $name;
         $this->index = $index;
@@ -56,10 +54,10 @@ public function initialize(string $name, int $index, array $options, DataTable $
     /**
      * The transform function is responsible for converting column-appropriate input to a datatables-usable type.
      *
-     * @param mixed|null $value The single value of the column, if mapping makes it possible to derive one
-     * @param mixed|null $context All relevant data of the entire row
+     * @param mixed $value The single value of the column, if mapping makes it possible to derive one
+     * @param mixed $context All relevant data of the entire row
      */
-    public function transform($value = null, $context = null)
+    public function transform(mixed $value = null, mixed $context = null): mixed
     {
         $data = $this->getData();
         if (is_callable($data)) {
@@ -74,10 +72,10 @@ public function transform($value = null, $context = null)
     /**
      * Apply final modifications before rendering to result.
      *
+     * @param mixed $value The raw data pending rendering
      * @param mixed $context All relevant data of the entire row
-     * @return mixed|string
      */
-    protected function render($value, $context)
+    protected function render(mixed $value, mixed $context): mixed
     {
         if (is_string($render = $this->options['render'])) {
             return sprintf($render, $value);
@@ -88,17 +86,9 @@ protected function render($value, $context)
         return $value;
     }
 
-    /**
-     * The normalize function is responsible for converting parsed and processed data to a datatables-appropriate type.
-     *
-     * @param mixed $value The single value of the column
-     */
-    abstract public function normalize($value);
+    abstract public function normalize(mixed $value): mixed;
 
-    /**
-     * @return $this
-     */
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         $resolver
             ->setDefaults([
@@ -148,34 +138,22 @@ public function getName(): string
         return $this->name;
     }
 
-    /**
-     * @return string|null
-     */
-    public function getLabel()
+    public function getLabel(): ?string
     {
         return $this->options['label'] ?? "{$this->dataTable->getName()}.columns.{$this->getName()}";
     }
 
-    /**
-     * @return string|null
-     */
-    public function getField()
+    public function getField(): ?string
     {
         return $this->options['field'];
     }
 
-    /**
-     * @return string|null
-     */
-    public function getPropertyPath()
+    public function getPropertyPath(): ?string
     {
         return $this->options['propertyPath'];
     }
 
-    /**
-     * @return callable|string|null
-     */
-    public function getData()
+    public function getData(): callable|string|null
     {
         return $this->options['data'];
     }
@@ -195,18 +173,12 @@ public function isOrderable(): bool
         return $this->options['orderable'] ?? !empty($this->getOrderField());
     }
 
-    /**
-     * @return AbstractFilter
-     */
-    public function getFilter()
+    public function getFilter(): AbstractFilter
     {
         return $this->options['filter'];
     }
 
-    /**
-     * @return string|null
-     */
-    public function getOrderField()
+    public function getOrderField(): ?string
     {
         return $this->options['orderField'] ?? $this->getField();
     }
@@ -216,10 +188,7 @@ public function isGlobalSearchable(): bool
         return $this->options['globalSearchable'] ?? $this->isSearchable();
     }
 
-    /**
-     * @return string
-     */
-    public function getLeftExpr()
+    public function getLeftExpr(): string
     {
         $leftExpr = $this->options['leftExpr'];
         if (null === $leftExpr) {
@@ -232,7 +201,7 @@ public function getLeftExpr()
         return $leftExpr;
     }
 
-    public function getRightExpr($value)
+    public function getRightExpr(mixed $value): string
     {
         $rightExpr = $this->options['rightExpr'];
         if (null === $rightExpr) {
@@ -245,18 +214,12 @@ public function getRightExpr($value)
         return $rightExpr;
     }
 
-    /**
-     * @return string
-     */
-    public function getOperator()
+    public function getOperator(): string
     {
         return $this->options['operator'];
     }
 
-    /**
-     * @return string
-     */
-    public function getClassName()
+    public function getClassName(): string
     {
         return $this->options['className'];
     }
@@ -271,21 +234,14 @@ public function getState(): DataTableState
         return $this->dataTable->getState();
     }
 
-    /**
-     * @return $this
-     */
-    public function setOption(string $name, $value): self
+    public function setOption(string $name, mixed $value): static
     {
         $this->options[$name] = $value;
 
         return $this;
     }
 
-    /**
-     * @param string $value
-     * @return bool
-     */
-    public function isValidForSearch($value)
+    public function isValidForSearch(string $value): bool
     {
         return true;
     }

diff --git a/src/Column/BoolColumn.php b/src/Column/BoolColumn.php
@@ -21,7 +21,7 @@
  */
 class BoolColumn extends AbstractColumn
 {
-    public function normalize($value): string
+    public function normalize(mixed $value): string
     {
         if (null === $value) {
             return $this->getNullValue();
@@ -30,7 +30,7 @@ public function normalize($value): string
         return ((bool) $value) ? $this->getTrueValue() : $this->getFalseValue();
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);
 
@@ -69,11 +69,7 @@ public function getNullValue(): string
         return $this->options['nullValue'];
     }
 
-    /**
-     * @param string $value
-     * @return bool
-     */
-    public function isValidForSearch($value)
+    public function isValidForSearch(string $value): bool
     {
         $value = trim(mb_strtolower($value));
 

diff --git a/src/Column/DateTimeColumn.php b/src/Column/DateTimeColumn.php
@@ -21,7 +21,7 @@
  */
 class DateTimeColumn extends AbstractColumn
 {
-    public function normalize($value)
+    public function normalize(mixed $value): mixed
     {
         if (null === $value) {
             return $this->options['nullValue'];
@@ -31,7 +31,9 @@ public function normalize($value)
             if (!empty($this->options['createFromFormat'])) {
                 $value = \DateTime::createFromFormat($this->options['createFromFormat'], (string) $value);
                 if (false === $value) {
-                    $errors = \DateTime::getLastErrors();
+                    if (false === ($errors = \DateTime::getLastErrors())) {
+                        throw new \LogicException('DateTime conversion failed for unknown reasons');
+                    }
                     throw new \Exception(implode(', ', $errors['errors'] ?: $errors['warnings']));
                 }
             } else {
@@ -42,7 +44,7 @@ public function normalize($value)
         return $value->format($this->options['format']);
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);
 

diff --git a/src/Column/MapColumn.php b/src/Column/MapColumn.php
@@ -21,12 +21,12 @@
  */
 class MapColumn extends TextColumn
 {
-    public function normalize($value): string
+    public function normalize(mixed $value): string
     {
         return parent::normalize($this->options['map'][$value] ?? $this->options['default'] ?? $value);
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);
 

diff --git a/src/Column/NumberColumn.php b/src/Column/NumberColumn.php
@@ -21,7 +21,7 @@
  */
 class NumberColumn extends AbstractColumn
 {
-    public function normalize($value): string
+    public function normalize(mixed $value): string
     {
         $value = (string) $value;
         if (is_numeric($value)) {
@@ -31,7 +31,7 @@ public function normalize($value): string
         return $this->isRaw() ? $value : (string) floatval($value);
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);
 
@@ -48,11 +48,7 @@ public function isRaw(): bool
         return $this->options['raw'];
     }
 
-    /**
-     * @param string $value
-     * @return bool
-     */
-    public function isValidForSearch($value)
+    public function isValidForSearch(string $value): bool
     {
         return is_numeric($value);
     }

diff --git a/src/Column/TextColumn.php b/src/Column/TextColumn.php
@@ -21,14 +21,14 @@
  */
 class TextColumn extends AbstractColumn
 {
-    public function normalize($value): string
+    public function normalize(mixed $value): string
     {
         $value = (string) $value;
 
         return $this->isRaw() ? $value : htmlspecialchars($value, ENT_QUOTES | ENT_SUBSTITUTE);
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);
 

diff --git a/src/Column/TwigColumn.php b/src/Column/TwigColumn.php
@@ -23,20 +23,16 @@
  */
 class TwigColumn extends AbstractColumn
 {
-    /** @var Environment */
-    protected $twig;
+    protected Environment $twig;
 
-    /**
-     * TwigColumn constructor.
-     */
     public function __construct(Environment $twig = null)
     {
         if (null === ($this->twig = $twig)) {
             throw new MissingDependencyException('You must have TwigBundle installed to use ' . static::class);
         }
     }
 
-    protected function render($value, $context)
+    protected function render($value, $context): mixed
     {
         return $this->twig->render($this->getTemplate(), [
             'row' => $context,
@@ -45,12 +41,12 @@ protected function render($value, $context)
         ]);
     }
 
-    public function normalize($value)
+    public function normalize(mixed $value): mixed
     {
         return $value;
     }
 
-    protected function configureOptions(OptionsResolver $resolver)
+    protected function configureOptions(OptionsResolver $resolver): static
     {
         parent::configureOptions($resolver);