Add clear option to Flash Message

To give user the option to disable Stacking of messages and being consistent with 3.x
cakephp · Oct 31, 2016 · e1c5ef9 · e1c5ef9
1 parent 924d382
commit e1c5ef9
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/lib/Cake/Controller/Component/FlashComponent.php b/lib/Cake/Controller/Component/FlashComponent.php
@@ -38,6 +38,7 @@ class FlashComponent extends Component {
 		'key' => 'flash',
 		'element' => 'default',
 		'params' => array(),
+		'clear' => false
 	);
 
 /**
@@ -82,7 +83,10 @@ public function set($message, $options = array()) {
 		}
 		$options['element'] = $plugin . 'Flash/' . $element;
 
-		$messages = CakeSession::read('Message.' . $options['key']);
+		$messages = array();
+		if ($options['clear'] === false) {
+			$messages = (array)CakeSession::read('Message.' . $options['key']);
+		}
 
 		$newMessage = array(
 			'message' => $message,

diff --git a/lib/Cake/Test/Case/Controller/Component/FlashComponentTest.php b/lib/Cake/Test/Case/Controller/Component/FlashComponentTest.php
@@ -131,6 +131,20 @@ public function testSet() {
 		$result = CakeSession::read('Message.foobar');
 		$this->assertEquals($expected, $result);
 		CakeSession::delete('Message.foobar');
+
+		$this->Flash->set('This is the first message');
+		$this->Flash->set('This is the second message', array('clear' => true));
+		$expected = array(
+			array(
+				'message' => 'This is the second message',
+				'key' => 'flash',
+				'element' => 'Flash/default',
+				'params' => array()
+			)
+		);
+		$result = CakeSession::read('Message.flash');
+		$this->assertEquals($expected, $result);
+		CakeSession::delete('Message.flash');
 	}
 
 /**