Class SessionHelper

_render()source protected

_render( array $flash )

Renders a flash message

Parameters

array $flash

Flash message array

Returns

string

check()source public

check( string $name )

Checks if a session key has been set.

In your view: $this->Session->check('Controller.sessKey');

Parameters

string $name

Session key to check.

Returns

boolean

Link

https://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#SessionHelper::check

consume()source public

consume( string $name )

Reads and deletes a session value for a key.

In your view: $this->Session->consume('Controller.sessKey');

Parameters

string $name

the name of the session key you want to read

Returns

mixed
values from the session vars

error()source public

error( )

Returns last error encountered in a session

In your view: $this->Session->error();

Returns

string
last error

Link

https://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#displaying-notifications-or-flash-messages

flash()source public

flash( string $key 'flash' , array $attrs array() )

Used to render the message set in Controller::Session::setFlash()

In your view: $this->Session->flash('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->Session->flash('flash', array('params' => array('class' => 'new-flash')));

The above would generate a flash message with a custom class name. Using $attrs['params'] you can pass additional data into the element rendering that will be made available as local variables when the element is rendered:

echo $this->Session->flash('flash', array('params' => array('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 rendered when creating the flash message. Using custom elements allows you to fully customize how flash messages are generated.

echo $this->Session->flash('flash', array('element' => 'my_custom_element'));

If you want to use an element from a plugin for rendering your flash message you can do that using the plugin param:

echo $this->Session->flash('flash', array(
    'element' => 'my_custom_element',
    'params' => array('plugin' => 'my_plugin')
));

Deprecated

3.0.0 Since 2.7, use FlashHelper::render() instead.

Parameters

string $key optional 'flash'

The [Message.]key you are rendering in the view.

array $attrs optional array()

Additional attributes to use for the creation of this flash message. Supports the 'params', and 'element' keys that are used in the helper.

Returns

string

Link

https://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#SessionHelper::flash

read()source public

read( string $name null )

Reads a session value for a key or returns values for all keys.

In your view: $this->Session->read('Controller.sessKey'); Calling the method without a param will return all session vars

Parameters

string $name optional null

the name of the session key you want to read

Returns

mixed
values from the session vars

Link

https://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#SessionHelper::read

valid()source public

valid( )

Used to check is a session is valid in a view

Returns

boolean

Link

https://book.cakephp.org/2.0/en/core-libraries/helpers/session.html#SessionHelper::valid