Documentation

instance($instance = null)

The instance method returns the default session instance, or a specific instance, identified by name.

null

// get the default session instance (identified by the 'driver' configuration setting).
$session = Session::instance();

// get a specific session instance
$session = Session::instance('myappcookie');

set($variable, $value = null)

The set method allows you to set a session variable.

null

// store the userid in the session
Session::set('userid', $userid);

// you can also store more complex values
Session::set('array', array('varA', 'varB', 'varC' => array('val1', 'val2'));

// you can also use an array to set multiple values at the same time
Session::set(array(
	'userid' => $userid,
	'has_cookies' => function()
	{
		return (bool) \Cookie::get('has_them', false);
	}
));

// You can also chain on calls to set values
Session::set('userid', $userid)->set('foo', 'bar');

get($variable = null, $default = null)

The get method allows you to retrieve stored variables from the session.

null

null

// get the stored userid from the session
$userid = Session::get('userid');
if ( $userid === false )
{
	echo "no user is logged in";
}

// you can retrieve the entire array stored
$arr = Session::get('array');

// or get a specific key from the array
$arr = Session::get('array.varC');

// get all session variables
$vars = Session::get();

delete($variable)

The delete method allows you to delete a stored session variable.

// delete the stored userid from the session
Session::delete('userid');

// you can also delete a specific key from the array
Session::delete('array.varC');

set_flash($variable, $value = null)

The set_flash method allows you to set a session flash variable. Flash variables have a limited lifespan. Depending on the configuration, they will be deleted after the next page request, or after they are retrieved.

null

// tell the next page request which step to process
Session::set_flash('step', 2);

// you can also store more complex values
Session::set_flash('array', array('varA', 'varB', 'varC' => array('val1', 'val2')));

This method supports limited 'dot-notation' to save an element in a multidimensional array. Only the top-level is versioned, the entire multidimensional array will expire at the same time.

get_flash($variable, $default = null, $expire = false)

The get_flash method allows you to get a session flash variable. Flash variables have a limited lifespan. Depending on the configuration, they will be deleted after the next page request, or after they are retrieved.

null

false

// find out which step to process
$step = Session::get_flash('step');

This method supports 'dot-notation' to retrieve an element from a multidimensional array.

keep_flash($variable)

The keep_flash method resets a flash variable stored in the session to an 'unrequested' state. This allows you to get a flash variable, and still pass it on to the next page request.

// keep the step value for one more page request
Session::keep_flash('step');

delete_flash($variable)

The delete_flash method allows you to delete a stored flash variable.

// delete the step from the session
Session::delete_flash('userid');

create()

The create method allows you to create a new session. If a session is already present, it will be destroyed when the new one is created.

// create a new session
Session::create();

destroy()

The destroy method allows you to destroy an existing session.

// destroy a session
Session::destroy();

read()

The read method allows you to manually read a session. The session is automatically read when the session class is initialized, so under normal circumstances there is no need to use this method.

// read the session
Session::read();

write()

The write method allows you to manually write the session. Under normal circumstances, the session is automatically written when the script ends.

// write the session
Session::write();

rotate()

The rotate method allows you to manually rotate the session id. Under normal circumstances, the session id is automatically rotated periodically, as defined in the configuration. You might want to manually rotate it as an extra security measure, for example when you change the rights of the logged-in user.

// rotate the session
Session::rotate();

key()

The key method allows you retrieve elements of the session key, which uniquely identifies the session.

// get the current session id
$session_id = Session::key('session_id');