Welcome to Het Cookbook

	array('User' => 
			array('username' => 'clarkKent@dailyplanet.com')
	);

write($name, $value)

Write to the Session puts $value into $name. $name can be a dot separated array. For example:

$this->Session->write('Person.eyeColor', 'Green');

1. $this->Session->write('Person.eyeColor', 'Green');

This writes the value 'Green' to the session under Person => eyeColor.

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.

setFlash('Example message text', 'default', array('class' => 'example_class'))

1. 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>

read($name)

Returns the value at $name in the Session. If $name is null the entire session will be returned. E.g.

$green = $this->Session->read('Person.eyeColor');

1. $green = $this->Session->read('Person.eyeColor');

Retrieve the value Green from the session.

check($name)

Used to check if a Session variable has been set. Returns true on existence and false on non-existence.

delete($name) /*or*/ del($name)

Clear the session data at $name. E.g.

$this->Session->del('Person.eyeColor');

1. $this->Session->del('Person.eyeColor');

Our session data no longer has the value 'Green', or the index eyeColor set. However, Person is still in the Session. To delete the entire Person information from the session use.

$this->Session->del('Person');

1. $this->Session->del('Person');

The destroy method will delete the session cookie and all session data stored in the temporary file system. It will then destroy the PHP session and then create a fresh session.

$this->Session->destroy()

1. $this->Session->destroy()

error()

Used to determine the last error in a session.