Standardized ordering field handling and added validation for short URLs list

module/Core/src/Model/Ordering.php

@@ -0,0 +1,35 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Shlinkio\Shlink\Core\Model;
+
+final class Ordering
+{
+    private const DEFAULT_DIR = 'ASC';
+
+    private function __construct(private ?string $field, private string $dir)
+    {
+    }
+
+    public static function fromTuple(array $props): self
+    {
+        [$field, $dir] = $props;
+        return new self($field, $dir ?? self::DEFAULT_DIR);
+    }
+
+    public function orderField(): ?string
+    {
+        return $this->field;
+    }
+
+    public function orderDirection(): string
+    {
+        return $this->dir;
+    }
+
+    public function hasOrderField(): bool
+    {
+        return $this->field !== null;
+    }
+}

module/Core/src/Model/ShortUrlsOrdering.php

@@ -1,60 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Shlinkio\Shlink\Core\Model;
-
-use Shlinkio\Shlink\Core\Exception\ValidationException;
-
-use function array_pad;
-use function explode;
-
-final class ShortUrlsOrdering
-{
-    public const ORDER_BY = 'orderBy';
-    private const DEFAULT_ORDER_DIRECTION = 'ASC';
-
-    private ?string $orderField = null;
-    private string $orderDirection = self::DEFAULT_ORDER_DIRECTION;
-
-    /**
-     * @throws ValidationException
-     */
-    public static function fromRawData(array $query): self
-    {
-        $instance = new self();
-        $instance->validateAndInit($query);
-
-        return $instance;
-    }
-
-    /**
-     * @throws ValidationException
-     */
-    private function validateAndInit(array $data): void
-    {
-        $orderBy = $data[self::ORDER_BY] ?? null;
-        if ($orderBy === null) {
-            return;
-        }
-
-        [$field, $dir] = array_pad(explode('-', $orderBy), 2, null);
-        $this->orderField = $field;
-        $this->orderDirection = $dir ?? self::DEFAULT_ORDER_DIRECTION;
-    }
-
-    public function orderField(): ?string
-    {
-        return $this->orderField;
-    }
-
-    public function orderDirection(): string
-    {
-        return $this->orderDirection;
-    }
-
-    public function hasOrderField(): bool
-    {
-        return $this->orderField !== null;
-    }
-}

module/Core/src/Model/ShortUrlsParams.php

@@ -13,6 +13,7 @@ use function Shlinkio\Shlink\Core\parseDateField;
 
 final class ShortUrlsParams
 {
+    public const ORDERABLE_FIELDS = ['longUrl', 'shortCode', 'dateCreated', 'title', 'visits'];
     public const DEFAULT_ITEMS_PER_PAGE = 10;
     public const TAGS_MODE_ANY = 'any';
     public const TAGS_MODE_ALL = 'all';
@@ -23,7 +24,7 @@ final class ShortUrlsParams
     private array $tags;
     /** @var self::TAGS_MODE_ANY|self::TAGS_MODE_ALL */
     private string $tagsMode = self::TAGS_MODE_ANY;
-    private ShortUrlsOrdering $orderBy;
+    private Ordering $orderBy;
     private ?DateRange $dateRange;
 
     private function __construct()
@@ -63,7 +64,7 @@ final class ShortUrlsParams
             parseDateField($inputFilter->getValue(ShortUrlsParamsInputFilter::START_DATE)),
             parseDateField($inputFilter->getValue(ShortUrlsParamsInputFilter::END_DATE)),
         );
-        $this->orderBy = ShortUrlsOrdering::fromRawData($query);
+        $this->orderBy = Ordering::fromTuple($inputFilter->getValue(ShortUrlsParamsInputFilter::ORDER_BY));
         $this->itemsPerPage = (int) (
             $inputFilter->getValue(ShortUrlsParamsInputFilter::ITEMS_PER_PAGE) ?? self::DEFAULT_ITEMS_PER_PAGE
         );
@@ -90,7 +91,7 @@ final class ShortUrlsParams
         return $this->tags;
     }
 
-    public function orderBy(): ShortUrlsOrdering
+    public function orderBy(): Ordering
     {
         return $this->orderBy;
     }