Back port of Flash component & helper

lib/Cake/Controller/Component/FlashComponent.php

@@ -0,0 +1,120 @@
+<?php
+/**
+ * Flash Component
+ *
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @package       Cake.Controller.Component
+ * @since         CakePHP(tm) v 2.7.0-dev
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+
+App::uses('Component', 'Controller');
+App::uses('Inflector', 'Utility');
+App::uses('CakeSession', 'Model/Datasource');
+
+/**
+ * The CakePHP FlashComponent provides a way for you to write a flash variable
+ * to the session from your controllers, to be rendered in a view with the
+ * FlashHelper.
+ *
+ * @package       Cake.Controller.Component
+ */
+class FlashComponent extends Component {
+
+/**
+ * Default configuration
+ *
+ * @var array
+ */
+	protected $_defaultConfig = array(
+		'key' => 'flash',
+		'element' => 'default',
+		'params' => array(),
+	);
+
+/**
+ * Constructor
+ *
+ * @param ComponentCollection $collection
+ * @param array $settings
+ */
+	public function __construct(ComponentCollection $collection, $settings = array()) {
+		$this->_defaultConfig = Hash::merge($this->_defaultConfig, $settings);
+	}
+
+/**
+ * Used to set a session variable that can be used to output messages in the view.
+ *
+ * In your controller: $this->Flash->set('This has been saved');
+ *
+ * ### Options:
+ *
+ * - `key` The key to set under the session's Flash key
+ * - `element` The element used to render the flash message. Default to 'default'.
+ * - `params` An array of variables to make available when using an element
+ *
+ * @param string $message Message to be flashed. If an instance
+ *   of Exception the exception message will be used and code will be set
+ *   in params.
+ * @param array $options An array of options.
+ * @return void
+ */
+
+	public function set($message, $options = array()) {
+		$options += $this->_defaultConfig;
+
+		if ($message instanceof Exception) {
+			$options['params'] += array('code' => $message->getCode());
+			$message = $message->getMessage();
+		}
+
+		list($plugin, $element) = pluginSplit($options['element']);
+
+		if ($plugin) {
+			$options['element'] = $plugin . '.Flash/' . $element;
+		} else {
+			$options['element'] = 'Flash/' . $element;
+		}
+
+		CakeSession::write('Flash.' . $options['key'], array(
+			'message' => $message,
+			'key' => $options['key'],
+			'element' => $options['element'],
+			'params' => $options['params']
+		));
+	}
+
+/**
+ * Magic method for verbose flash methods based on element names.
+ *
+ * For example: $this->Flash->success('My message') would use the
+ * success.ctp element under `app/View/Element/Flash` for rendering the
+ * flash message.
+ *
+ * @param string $name Element name to use.
+ * @param array $args Parameters to pass when calling `FlashComponent::set()`.
+ * @return void
+ * @throws InternalErrorException If missing the flash message.
+ */
+	public function __call($name, $args) {
+		$options = array('element' => Inflector::underscore($name));
+
+		if (count($args) < 1) {
+			throw new InternalErrorException(__('Flash message missing.'));
+		}
+
+		if (!empty($args[1])) {
+			$options += (array)$args[1];
+		}
+
+		$this->set($args[0], $options);
+	}
+}

lib/Cake/View/Helper/FlashHelper.php

@@ -0,0 +1,90 @@
+<?php
+/**
+ * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
+ * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ *
+ * Licensed under The MIT License
+ * For full copyright and license information, please see the LICENSE.txt
+ * Redistributions of files must retain the above copyright notice.
+ *
+ * @copyright     Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
+ * @link          http://cakephp.org CakePHP(tm) Project
+ * @package       Cake.View.Helper
+ * @since         CakePHP(tm) v 2.7.0-dev
+ * @license       http://www.opensource.org/licenses/mit-license.php MIT License
+ */
+
+App::uses('AppHelper', 'View/Helper');
+App::uses('CakeSession', 'Model/Datasource');
+
+/**
+ * FlashHelper class to render flash messages.
+ *
+ * After setting messages in your controllers with FlashComponent, you can use
+ * this class to output your flash messages in your views.
+ *
+ * @package       Cake.View.Helper
+ * @link http://book.cakephp.org/2.0/en/core-libraries/helpers/session.html
+ */
+class FlashHelper extends AppHelper {
+
+/**
+ * Used to render the message set in FlashComponent::set()
+ *
+ * In your view: $this->Flash->render('somekey');
+ * Will default to flash if no param is passed
+ *
+ * You can pass additional information into the flash message generation. This allows you
+ * to consolidate all the parameters for a given type of flash message into the view.
+ *
+ * ```
+ * echo $this->Flash->render('flash', ['params' => ['name' => $user['User']['name']]]);
+ * ```
+ *
+ * This would pass the current user's name into the flash message, so you could create personalized
+ * messages without the controller needing access to that data.
+ *
+ * Lastly you can choose the element that is used for rendering the flash message. Using
+ * custom elements allows you to fully customize how flash messages are generated.
+ *
+ * ```
+ * echo $this->Flash->render('flash', ['element' => 'my_custom_element']);
+ * ```
+ *
+ * If you want to use an element from a plugin for rendering your flash message
+ * you can use the dot notation for the plugin's element name:
+ *
+ * ```
+ * echo $this->Flash->render('flash', [
+ *   'element' => 'MyPlugin.my_custom_element',
+ * ]);
+ * ```
+ *
+ * @param string $key The [Flash.]key you are rendering in the view.
+ * @param array $options Additional options to use for the creation of this flash message.
+ *    Supports the 'params', and 'element' keys that are used in the helper.
+ * @return string|null Rendered flash message or null if flash key does not exist
+ *   in session.
+ * @throws UnexpectedValueException If value for flash settings key is not an array.
+ */
+	public function render($key = 'flash', $options = array()) {
+
+		if (!CakeSession::check("Message.$key")) {
+			return;
+		}
+
+		$flash = CakeSession::read("Message.$key");
+
+		if (!is_array($flash)) {
+			throw new UnexpectedValueException(sprintf(
+				'Value for flash setting key "%s" must be an array.',
+				$key
+			));
+		}
+
+		$flash = $options + $flash;
+		CakeSession::delete("Flash.$key");
+
+		return $this->_View->element($flash['element'], $flash);
+	}
+}