cakephp-tools/docs/Component/Flash.md

Flash Component

An enhanced FlashComponent capable of

• Stackable messages for each type
• Persistent (across requests) and transient messages
• Inject it into the headers, as X-Flash for example, for REST/AJAX requests

Configs

• 'headerKey' => 'X-Flash', // Set to empty string to deactivate
• 'sessionLimit' => 99 // Max message limit for Session to avoid session flooding (Configure uses 99 fixed)

Usage

Attach it to your controllers in initialize() like so:

$this->loadComponent('Tools.Flash');

Also add the helper for it:

public $helpers = array('Tools.Flash');

In your layouts, you don't need to change the $this->Flash->render() call, as the syntax for this helper is the same.

Basic Example

// Inside an action
$this->Flash->message('Yeah it works.', 'success');
$this->Flash->message('Careful.', 'warning');
$this->Flash->message('O o.', 'error');

You can also use the new syntactic sugar:

// Inside an action
$this->Flash->success('Yeah it works.');
$this->Flash->warning('Careful.');
$this->Flash->error('O o.');

Notes

It will also work with the AuthComponent, which internally uses FlashComponent::set(). This method has been provides as core hook internally.

You can use any type (success, warning, error, info, ...) of message, except the two reserved ones message and set. At least if you plan on using the magic method invokation. But even if not, it would be good practice to not use those two.