Welcome to The Cookbook

setFlash($message, $layout = 'default', $params = array(), $key = 'flash')

Used to set a session variable that can be used for output in the View. $layout allows you to control which layout (located in /app/views/layouts) should be used to render the message in. If you leave the $layout set to 'default', the message will be wrapped with the following:

<div id="flashMessage" class="message"> [message] </div>

1. <div id="flashMessage" class="message"> [message] </div>

$params allows you to pass additional view variables to the rendered layout. $key sets the $messages index in the Message array. Default is 'flash'.

Parameters can be passed affecting the rendered div, for example padding "class" in the $params array will apply a class to the div output using $session->flash() in your layout or view.

$this->Session->setFlash('Example message text', 'default', array('class' => 'example_class'))

1. $this->Session->setFlash('Example message text', 'default', array('class' => 'example_class'))

The output from using $session->flash() with the above example would be:

<div id="flashMessage" class="example_class">Example message text</div>

1. <div id="flashMessage" class="example_class">Example message text</div>