Implement clearMessage & clearMessages()

Based on MrSam's code in #30.
slimphp · Oct 22, 2017 · dc82bd3 · dc82bd3
1 parent 3018642
commit dc82bd3
Show file tree

Hide file tree

Showing 2 changed files with 71 additions and 0 deletions.
diff --git a/src/Messages.php b/src/Messages.php
@@ -171,4 +171,40 @@ public function hasMessage($key)
         $messages = $this->getMessages();
         return isset($messages[$key]);
     }
+
+    /**
+     * Clear all messages
+     *
+     * @return void
+     */
+    public function clearMessages()
+    {
+        if (isset($this->storage[$this->storageKey])) {
+            $this->storage[$this->storageKey] = [];
+        }
+
+        $this->fromPrevious = [];
+        $this->forNow = [];
+    }
+
+    /**
+     * Clear specific message
+     *
+     * @param  String $key The key to clear
+     * @return void
+     */
+    public function clearMessage($key)
+    {
+        if (isset($this->storage[$this->storageKey][$key])) {
+            unset($this->storage[$this->storageKey][$key]);
+        }
+
+        if (isset($this->fromPrevious[$key])) {
+            unset($this->fromPrevious[$key]);
+        }
+
+        if (isset($this->forNow[$key])) {
+            unset($this->forNow[$key]);
+        }
+    }
 }
diff --git a/tests/MessagesTest.php b/tests/MessagesTest.php
@@ -234,4 +234,39 @@ public function testHasMessage()
         $flash = new Messages($storage);
         $this->assertTrue($flash->hasMessage('Test'));
     }
+
+    public function testClearMessages()
+    {
+        $storage = ['slimFlash' => []];
+        $flash = new Messages($storage);
+
+        $storage = ['slimFlash' => [ 'Test' => ['Test']]];
+        $flash = new Messages($storage);
+        $flash->addMessageNow('Now', 'hear this');
+        $this->assertTrue($flash->hasMessage('Test'));
+        $this->assertTrue($flash->hasMessage('Now'));
+
+        $flash->clearMessages();
+        $this->assertFalse($flash->hasMessage('Test'));
+        $this->assertFalse($flash->hasMessage('Now'));
+    }
+
+    public function testClearMessage()
+    {
+        $storage = ['slimFlash' => []];
+        $flash = new Messages($storage);
+
+        $storage = ['slimFlash' => [ 'Test' => ['Test'], 'Foo' => ['Bar']]];
+        $flash = new Messages($storage);
+        $flash->addMessageNow('Now', 'hear this');
+        $this->assertTrue($flash->hasMessage('Test'));
+        $this->assertTrue($flash->hasMessage('Foo'));
+        $this->assertTrue($flash->hasMessage('Now'));
+
+        $flash->clearMessage('Test');
+        $flash->clearMessage('Now');
+        $this->assertFalse($flash->hasMessage('Test'));
+        $this->assertFalse($flash->hasMessage('Now'));
+        $this->assertTrue($flash->hasMessage('Foo'));
+    }
 }