Projects / li3_flash_message

diff --git a/extensions/helper/FlashMessage.php b/extensions/helper/FlashMessage.php index c5a472b..6fc0bb0 100644 --- a/extensions/helper/FlashMessage.php +++ b/extensions/helper/FlashMessage.php @@ -53,7 +53,7 @@ class FlashMessage extends \lithium\template\Helper { $view = $this->_context->view(); $output = ''; $type = array($options['type'] => $options['template']); - $flash = $storage::get($key); + $flash = $storage::read($key); if (!empty($flash)) { $data = $options['data'] + array('message' => $flash['message']) + $flash['atts']; diff --git a/extensions/storage/FlashMessage.php b/extensions/storage/FlashMessage.php index 1227d92..2017d75 100644 --- a/extensions/storage/FlashMessage.php +++ b/extensions/storage/FlashMessage.php @@ -14,18 +14,10 @@ use \lithium\storage\Session; * Class for setting, getting and clearing flash messages. Use this class inside your * controllers to set messages for your views. * - * The class requires a configuration named `flash_message` for `\lithium\storage\Session`, e.g.: - * {{{ - * Session::config(array( - * 'flash_message' => array('adapter' => 'Php') - * )); - * }}} - * - * After that you can easily set messages and output them in your views. For example: * {{{ * // Controller * if (empty($data)) { - * FlashMessage::set('Invalid data.'); + * FlashMessage::write('Invalid data.'); * } * * // View @@ -39,28 +31,27 @@ class FlashMessage extends \lithium\core\StaticObject { ); /** - * Sets a flash message. + * Writes a flash message. * * @param string $message Message that will be stored. * @param array [$atts] Optional attributes that will be available in the view. * @param string [$key] Optional key to store multiple flash messages. - * @return void + * @return boolean True on successful write, false otherwise. */ - public static function set($message, array $atts = array(), $key = 'default') { + public static function write($message, array $atts = array(), $key = 'default') { $session = static::$_classes['session']; - $session::write("FlashMessage.{$key}", compact('message', 'atts'), array('name' => 'default')); + return $session::write("FlashMessage.{$key}", compact('message', 'atts'), array('name' => 'default')); } /** - * Gets the a flash message. + * Reads a flash message. * * @param string [$key] Optional key. - * @return array + * @return array The stored flash message. */ - public static function get($key = 'default') { + public static function read($key = 'default') { $session = static::$_classes['session']; - $flash = $session::read("FlashMessage.{$key}", array('name' => 'default')); - return $flash; + return $session::read("FlashMessage.{$key}", array('name' => 'default')); } /** @@ -75,7 +66,7 @@ class FlashMessage extends \lithium\core\StaticObject { if (!empty($key)) { $sessionKey .= ".{$key}"; } - $session::delete($sessionKey, array('name' => 'default')); + return $session::delete($sessionKey, array('name' => 'default')); } } diff --git a/tests/cases/extensions/storage/FlashMessageTest.php b/tests/cases/extensions/storage/FlashMessageTest.php index a706231..d3db405 100644 --- a/tests/cases/extensions/storage/FlashMessageTest.php +++ b/tests/cases/extensions/storage/FlashMessageTest.php @@ -25,53 +25,53 @@ class FlashMessageTest extends \lithium\test\Unit { Session::delete('FlashMessage'); } - public function testSet() { - FlashMessage::set('Foo'); + public function testWrite() { + FlashMessage::write('Foo'); $expected = array('message' => 'Foo', 'atts' => array()); $result = Session::read('FlashMessage.default', array('name' => 'default')); $this->assertEqual($expected, $result); - FlashMessage::set('Foo 2', array('type' => 'notice')); + FlashMessage::write('Foo 2', array('type' => 'notice')); $expected = array('message' => 'Foo 2', 'atts' => array('type' => 'notice')); $result = Session::read('FlashMessage.default', array('name' => 'default')); $this->assertEqual($expected, $result); - FlashMessage::set('Foo 3', array(), 'TestKey'); + FlashMessage::write('Foo 3', array(), 'TestKey'); $expected = array('message' => 'Foo 3', 'atts' => array()); $result = Session::read('FlashMessage.TestKey', array('name' => 'default')); $this->assertEqual($expected, $result); } - public function testGet() { - FlashMessage::set('Foo'); + public function testRead() { + FlashMessage::write('Foo'); $expected = array('message' => 'Foo', 'atts' => array()); - $result = FlashMessage::get(); + $result = FlashMessage::read(); $this->assertEqual($expected, $result); - FlashMessage::set('Foo 2', array('type' => 'notice')); + FlashMessage::write('Foo 2', array('type' => 'notice')); $expected = array('message' => 'Foo 2', 'atts' => array('type' => 'notice')); - $result = FlashMessage::get(); + $result = FlashMessage::read(); $this->assertEqual($expected, $result); - FlashMessage::set('Foo 3', array(), 'TestKey'); + FlashMessage::write('Foo 3', array(), 'TestKey'); $expected = array('message' => 'Foo 3', 'atts' => array()); - $result = FlashMessage::get('TestKey'); + $result = FlashMessage::read('TestKey'); $this->assertEqual($expected, $result); } public function testClear() { - FlashMessage::set('Foo'); + FlashMessage::write('Foo'); FlashMessage::clear(); $result = Session::read('FlashMessage.default', array('name' => 'default')); $this->assertNull($result); - FlashMessage::set('Foo 2', array(), 'TestKey'); + FlashMessage::write('Foo 2', array(), 'TestKey'); FlashMessage::clear('TestKey'); $result = Session::read('FlashMessage.TestKey', array('name' => 'default')); $this->assertNull($result); - FlashMessage::set('Foo 3', array(), 'TestKey2'); - FlashMessage::set('Foo 4', array(), 'TestKey3'); + FlashMessage::write('Foo 3', array(), 'TestKey2'); + FlashMessage::write('Foo 4', array(), 'TestKey3'); FlashMessage::clear(null); $result = Session::read('FlashMessage', array('name' => 'default')); $this->assertNull($result);