Merge pull request #596 from kamil-tekiela/OrderSortKeyword

OrderSortKeyword enum

Author: MauricioFauth

src/Components/GroupKeyword.php

@@ -13,8 +13,7 @@
  */
 final class GroupKeyword implements Component
 {
-    /** @var 'ASC'|'DESC'|null */
-    public string|null $type = null;
+    public OrderSortKeyword|null $type = null;
 
     /**
      * The expression that is used for grouping.

src/Components/OrderKeyword.php

@@ -19,21 +19,21 @@ final class OrderKeyword implements Component
     /**
      * The order type.
      */
-    public string $type;
+    public OrderSortKeyword $type;
 
     /**
-     * @param Expression|null $expr the expression that we are sorting by
-     * @param string          $type the sorting type
+     * @param Expression|null  $expr the expression that we are sorting by
+     * @param OrderSortKeyword $type the sorting type
      */
-    public function __construct(Expression|null $expr = null, string $type = 'ASC')
+    public function __construct(Expression|null $expr = null, OrderSortKeyword $type = OrderSortKeyword::Asc)
     {
         $this->expr = $expr;
         $this->type = $type;
     }
 
     public function build(): string
     {
-        return $this->expr . ' ' . $this->type;
+        return $this->expr . ' ' . $this->type->value;
     }
 
     public function __toString(): string

src/Components/OrderSortKeyword.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\SqlParser\Components;
+
+enum OrderSortKeyword: string
+{
+    case Asc = 'ASC';
+    case Desc = 'DESC';
+}

src/Parsers/GroupKeywords.php

@@ -5,6 +5,7 @@
 namespace PhpMyAdmin\SqlParser\Parsers;
 
 use PhpMyAdmin\SqlParser\Components\GroupKeyword;
+use PhpMyAdmin\SqlParser\Components\OrderSortKeyword;
 use PhpMyAdmin\SqlParser\Parseable;
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\TokensList;
@@ -66,7 +67,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
                     ($token->type === TokenType::Keyword)
                     && (($token->keyword === 'ASC') || ($token->keyword === 'DESC'))
                 ) {
-                    $expr->type = $token->keyword;
+                    $expr->type = OrderSortKeyword::from($token->keyword);
                 } elseif (($token->type === TokenType::Operator) && ($token->value === ',')) {
                     if (! empty($expr->expr)) {
                         $ret[] = $expr;

src/Parsers/OrderKeywords.php

@@ -5,6 +5,7 @@
 namespace PhpMyAdmin\SqlParser\Parsers;
 
 use PhpMyAdmin\SqlParser\Components\OrderKeyword;
+use PhpMyAdmin\SqlParser\Components\OrderSortKeyword;
 use PhpMyAdmin\SqlParser\Parseable;
 use PhpMyAdmin\SqlParser\Parser;
 use PhpMyAdmin\SqlParser\TokensList;
@@ -66,7 +67,7 @@ public static function parse(Parser $parser, TokensList $list, array $options =
                     ($token->type === TokenType::Keyword)
                     && (($token->keyword === 'ASC') || ($token->keyword === 'DESC'))
                 ) {
-                    $expr->type = $token->keyword;
+                    $expr->type = OrderSortKeyword::from($token->keyword);
                 } elseif (($token->type === TokenType::Operator) && ($token->value === ',')) {
                     if (! empty($expr->expr)) {
                         $ret[] = $expr;

tests/Components/OrderKeywordTest.php

@@ -6,6 +6,7 @@
 
 use PhpMyAdmin\SqlParser\Components\Expression;
 use PhpMyAdmin\SqlParser\Components\OrderKeyword;
+use PhpMyAdmin\SqlParser\Components\OrderSortKeyword;
 use PhpMyAdmin\SqlParser\Parsers\OrderKeywords;
 use PhpMyAdmin\SqlParser\Tests\TestCase;
 
@@ -17,8 +18,8 @@ public function testBuildAll(): void
             'a ASC, b DESC',
             OrderKeywords::buildAll(
                 [
-                    new OrderKeyword(new Expression('a'), 'ASC'),
-                    new OrderKeyword(new Expression('b'), 'DESC'),
+                    new OrderKeyword(new Expression('a'), OrderSortKeyword::Asc),
+                    new OrderKeyword(new Expression('b'), OrderSortKeyword::Desc),
                 ],
             ),
         );

tests/data/parser/parseDelete.out

@@ -547,7 +547,11 @@
                             "function": null,
                             "subquery": null
                         },
-                        "type": "ASC"
+                        "type": {
+                            "@type": "PhpMyAdmin\\SqlParser\\Components\\OrderSortKeyword",
+                            "name": "Asc",
+                            "value": "ASC"
+                        }
                     }
                 ],
                 "limit": null,

tests/data/parser/parseDelete4.out

@@ -277,7 +277,11 @@
                             "function": null,
                             "subquery": null
                         },
-                        "type": "ASC"
+                        "type": {
+                            "@type": "PhpMyAdmin\\SqlParser\\Components\\OrderSortKeyword",
+                            "name": "Asc",
+                            "value": "ASC"
+                        }
                     }
                 ],
                 "limit": null,

tests/data/parser/parseDelete5.out

@@ -343,7 +343,11 @@
                             "function": null,
                             "subquery": null
                         },
-                        "type": "ASC"
+                        "type": {
+                            "@type": "PhpMyAdmin\\SqlParser\\Components\\OrderSortKeyword",
+                            "name": "Asc",
+                            "value": "ASC"
+                        }
                     }
                 ],
                 "limit": {

tests/data/parser/parseDelete6.out

@@ -197,7 +197,11 @@
                             "function": null,
                             "subquery": null
                         },
-                        "type": "ASC"
+                        "type": {
+                            "@type": "PhpMyAdmin\\SqlParser\\Components\\OrderSortKeyword",
+                            "name": "Asc",
+                            "value": "ASC"
+                        }
                     }
                 ],
                 "limit": null,