From 7cdbfc2eaf5d452b1f16550fb80b17b8f92b37cb Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Maur=C3=ADcio=20Meneghini=20Fauth?= <mauricio@fauth.dev>
Date: Sat, 27 May 2023 15:36:26 -0300
Subject: [PATCH] Add Event enum for trigger events
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Maurício Meneghini Fauth <mauricio@fauth.dev>
---
 libraries/classes/Triggers/Event.php              | 15 +++++++++++++++
 libraries/classes/Triggers/Trigger.php            |  4 +++-
 libraries/classes/Triggers/Triggers.php           |  4 ++--
 .../classes/Plugins/Export/ExportHtmlwordTest.php |  4 ++--
 test/classes/Plugins/Export/ExportOdtTest.php     |  4 ++--
 .../classes/Plugins/Export/ExportTexytextTest.php |  4 ++--
 test/classes/Triggers/TriggerTest.php             |  3 ++-
 7 files changed, 28 insertions(+), 10 deletions(-)
 create mode 100644 libraries/classes/Triggers/Event.php

diff --git a/libraries/classes/Triggers/Event.php b/libraries/classes/Triggers/Event.php
new file mode 100644
index 0000000000..59f403a7f9
--- /dev/null
+++ b/libraries/classes/Triggers/Event.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Triggers;
+
+/**
+ * Indicates the kind of statement that activates the trigger.
+ */
+enum Event: string
+{
+    case Insert = 'INSERT';
+    case Update = 'UPDATE';
+    case Delete = 'DELETE';
+}
diff --git a/libraries/classes/Triggers/Trigger.php b/libraries/classes/Triggers/Trigger.php
index b3814d1557..8691bc81f8 100644
--- a/libraries/classes/Triggers/Trigger.php
+++ b/libraries/classes/Triggers/Trigger.php
@@ -12,7 +12,7 @@ final class Trigger
     public function __construct(
         public readonly string $name,
         public readonly string $timing,
-        public readonly string $event,
+        public readonly Event $event,
         public readonly string $table,
         public readonly string $statement,
         public readonly string $definer,
@@ -32,6 +32,8 @@ final class Trigger
             Assert::string($name);
             Assert::string($timing);
             Assert::string($event);
+            $event = Event::tryFrom($event);
+            Assert::notNull($event);
             Assert::string($table);
             Assert::string($statement);
             Assert::string($definer);
diff --git a/libraries/classes/Triggers/Triggers.php b/libraries/classes/Triggers/Triggers.php
index 2ec65bb574..67f1c39172 100644
--- a/libraries/classes/Triggers/Triggers.php
+++ b/libraries/classes/Triggers/Triggers.php
@@ -524,7 +524,7 @@ class Triggers
             $oneResult['name'] = $newTrigger->name;
             $oneResult['table'] = $newTrigger->table;
             $oneResult['action_timing'] = $newTrigger->timing;
-            $oneResult['event_manipulation'] = $newTrigger->event;
+            $oneResult['event_manipulation'] = $newTrigger->event->value;
             $oneResult['definition'] = $newTrigger->statement;
             $oneResult['definer'] = $newTrigger->definer;
 
@@ -536,7 +536,7 @@ class Triggers
                 "CREATE TRIGGER %s %s %s ON %s\n FOR EACH ROW %s\n%s\n",
                 $oneResult['full_trigger_name'],
                 $newTrigger->timing,
-                $newTrigger->event,
+                $newTrigger->event->value,
                 Util::backquote($newTrigger->table),
                 $newTrigger->statement,
                 $delimiter,
diff --git a/test/classes/Plugins/Export/ExportHtmlwordTest.php b/test/classes/Plugins/Export/ExportHtmlwordTest.php
index 5f007841a9..9a3d2ee475 100644
--- a/test/classes/Plugins/Export/ExportHtmlwordTest.php
+++ b/test/classes/Plugins/Export/ExportHtmlwordTest.php
@@ -570,7 +570,7 @@ class ExportHtmlwordTest extends AbstractTestCase
             [
                 'TRIGGER_SCHEMA' => 'database',
                 'TRIGGER_NAME' => 'tna"me',
-                'EVENT_MANIPULATION' => 'manip&',
+                'EVENT_MANIPULATION' => 'UPDATE',
                 'EVENT_OBJECT_TABLE' => 'table',
                 'ACTION_TIMING' => 'ac>t',
                 'ACTION_STATEMENT' => 'def',
@@ -591,7 +591,7 @@ class ExportHtmlwordTest extends AbstractTestCase
         $this->assertStringContainsString(
             '<td class="print">tna&quot;me</td>' .
             '<td class="print">ac&gt;t</td>' .
-            '<td class="print">manip&amp;</td>' .
+            '<td class="print">UPDATE</td>' .
             '<td class="print">def</td>',
             $result,
         );
diff --git a/test/classes/Plugins/Export/ExportOdtTest.php b/test/classes/Plugins/Export/ExportOdtTest.php
index 86a1634b4d..547013875e 100644
--- a/test/classes/Plugins/Export/ExportOdtTest.php
+++ b/test/classes/Plugins/Export/ExportOdtTest.php
@@ -735,7 +735,7 @@ class ExportOdtTest extends AbstractTestCase
             [
                 'TRIGGER_SCHEMA' => 'database',
                 'TRIGGER_NAME' => 'tna"me',
-                'EVENT_MANIPULATION' => 'manip&',
+                'EVENT_MANIPULATION' => 'INSERT',
                 'EVENT_OBJECT_TABLE' => 'ta<ble',
                 'ACTION_TIMING' => 'ac>t',
                 'ACTION_STATEMENT' => 'def',
@@ -761,7 +761,7 @@ class ExportOdtTest extends AbstractTestCase
 
         $this->assertStringContainsString('<text:p>ac&gt;t</text:p>', $result);
 
-        $this->assertStringContainsString('<text:p>manip&amp;</text:p>', $result);
+        $this->assertStringContainsString('<text:p>INSERT</text:p>', $result);
 
         $this->assertStringContainsString('<text:p>def</text:p>', $result);
     }
diff --git a/test/classes/Plugins/Export/ExportTexytextTest.php b/test/classes/Plugins/Export/ExportTexytextTest.php
index 11b0e2942f..f76e5b6950 100644
--- a/test/classes/Plugins/Export/ExportTexytextTest.php
+++ b/test/classes/Plugins/Export/ExportTexytextTest.php
@@ -327,7 +327,7 @@ class ExportTexytextTest extends AbstractTestCase
             [
                 'TRIGGER_SCHEMA' => 'database',
                 'TRIGGER_NAME' => 'tna"me',
-                'EVENT_MANIPULATION' => 'manip&',
+                'EVENT_MANIPULATION' => 'DELETE',
                 'EVENT_OBJECT_TABLE' => 'ta<ble',
                 'ACTION_TIMING' => 'ac>t',
                 'ACTION_STATEMENT' => 'def',
@@ -344,7 +344,7 @@ class ExportTexytextTest extends AbstractTestCase
 
         $result = $this->object->getTriggers('database', 'ta<ble');
 
-        $this->assertStringContainsString('|tna"me|ac>t|manip&|def', $result);
+        $this->assertStringContainsString('|tna"me|ac>t|DELETE|def', $result);
 
         $this->assertStringContainsString('|Name|Time|Event|Definition', $result);
     }
diff --git a/test/classes/Triggers/TriggerTest.php b/test/classes/Triggers/TriggerTest.php
index 4f30c90c66..1d3ddba1a0 100644
--- a/test/classes/Triggers/TriggerTest.php
+++ b/test/classes/Triggers/TriggerTest.php
@@ -4,6 +4,7 @@ declare(strict_types=1);
 
 namespace PhpMyAdmin\Tests\Triggers;
 
+use PhpMyAdmin\Triggers\Event;
 use PhpMyAdmin\Triggers\Trigger;
 use PHPUnit\Framework\TestCase;
 
@@ -26,7 +27,7 @@ class TriggerTest extends TestCase
         $this->assertNotNull($actual);
         $this->assertSame('trigger_name', $actual->name);
         $this->assertSame('BEFORE', $actual->timing);
-        $this->assertSame('UPDATE', $actual->event);
+        $this->assertSame(Event::Update, $actual->event);
         $this->assertSame('test_table', $actual->table);
         $this->assertSame('BEGIN END', $actual->statement);
         $this->assertSame('definer@localhost', $actual->definer);