Add a flash messages service provider

Used to persist messages from the current request to the next
request.

Signed-off-by: Maurício Meneghini Fauth <[email protected]>

Author: MauricioFauth

libraries/classes/FlashMessages.php

@@ -0,0 +1,54 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin;
+
+use RuntimeException;
+
+final class FlashMessages
+{
+    private const STORAGE_KEY = 'flashMessages';
+
+    /** @var array */
+    private $storage;
+
+    /** @var array<string, string[]> */
+    private $previousMessages = [];
+
+    public function __construct()
+    {
+        if (! isset($_SESSION)) {
+            throw new RuntimeException(__('Session not found.'));
+        }
+
+        $this->storage = &$_SESSION;
+
+        if (isset($this->storage[self::STORAGE_KEY])) {
+            $this->previousMessages = $this->storage[self::STORAGE_KEY];
+        }
+
+        $this->storage[self::STORAGE_KEY] = [];
+    }
+
+    public function addMessage(string $key, string $message): void
+    {
+        if (! isset($this->storage[self::STORAGE_KEY][$key])) {
+            $this->storage[self::STORAGE_KEY][$key] = [];
+        }
+
+        $this->storage[self::STORAGE_KEY][$key][] = $message;
+    }
+
+    /** @return string[]|null */
+    public function getMessage(string $key): ?array
+    {
+        return $this->previousMessages[$key] ?? null;
+    }
+
+    /** @return array<string, string[]> */
+    public function getMessages(): array
+    {
+        return $this->previousMessages;
+    }
+}

test/classes/FlashMessagesTest.php

@@ -0,0 +1,63 @@
+<?php
+
+declare(strict_types=1);
+
+namespace PhpMyAdmin\Tests;
+
+use PhpMyAdmin\FlashMessages;
+use RuntimeException;
+
+class FlashMessagesTest extends AbstractTestCase
+{
+    private const STORAGE_KEY = 'flashMessages';
+
+    public function testConstructor(): void
+    {
+        $this->assertArrayNotHasKey(self::STORAGE_KEY, $_SESSION);
+        $flash = new FlashMessages();
+        $this->assertIsArray($_SESSION[self::STORAGE_KEY]);
+
+        $_SESSION = null;
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Session not found.');
+        $flash = new FlashMessages();
+    }
+
+    public function testAddMessage(): void
+    {
+        $flash = new FlashMessages();
+        $this->assertArrayNotHasKey('error', $_SESSION[self::STORAGE_KEY]);
+        $flash->addMessage('error', 'Error');
+        $this->assertArrayHasKey('error', $_SESSION[self::STORAGE_KEY]);
+        $this->assertIsArray($_SESSION[self::STORAGE_KEY]['error']);
+        $this->assertEquals(['Error'], $_SESSION[self::STORAGE_KEY]['error']);
+    }
+
+    public function testGetMessage(): void
+    {
+        $_SESSION[self::STORAGE_KEY] = ['warning' => ['Warning']];
+        $flash = new FlashMessages();
+        $message = $flash->getMessage('error');
+        $this->assertNull($message);
+        $message = $flash->getMessage('warning');
+        $this->assertEquals(['Warning'], $message);
+    }
+
+    public function testGetMessages(): void
+    {
+        $_SESSION[self::STORAGE_KEY] = [
+            'error' => ['Error1', 'Error2'],
+            'warning' => ['Warning'],
+        ];
+        $flash = new FlashMessages();
+        $flash->addMessage('notice', 'Notice');
+        $messages = $flash->getMessages();
+        $this->assertEquals(
+            [
+                'error' => ['Error1', 'Error2'],
+                'warning' => ['Warning'],
+            ],
+            $messages
+        );
+    }
+}