FuelPHP, a PHP 5.3 Framework Documentation

Session クラス

The session class allows you to maintain state for your application in the stateless environment of the web. It allows you to store variables on the server using a variety of storage solutions, and recall these variables on the next page request.

The static methods documented on this page use the session driver configured in the configuration via the driver setting. When you have set the auto_initialize setting to true, a session will be initialized when the Session class is loaded. If it is set to false, you will have to use one of the methods below, or start a session instance manually, to initialize the session.

If your application needs session support, either "always_load" your session class, or make sure your (base) controllers will load it. If you do load it, but you choose not to auto_initialize the session, and you don't use any of the session methods, the session will not be refreshed! This can cause unexpected behaviour of your application due to an expired session.

Garbage Collection

There session drivers have a built-in garbage collection mechanism to remove stale entries. Storage backends that have built-in support for data expiration, such as APC, Memcached or Redis, will use that feature, and will auto expire stale cache entries.

Storage backends that don't, for example the database or file system drivers, use the gc_probability setting to determine if garbage collection is needed. If so, they will run it in a shutdown event, after the page has been send to the user. Downside of this method is that if this takes some time, the page will not finished to be "loading..." until GC is completed.

When using sessions, make ABSOLUTELY sure that the timezone configured in your app/config/config.php and/or your php.ini file matches the timezone set on your server. Since cookie expiry timestamps are in GMT, expiry time calculation goes horribly wrong when you have a timezone mismatch, ranging from not expiring properly to session cookies not set at all because they arrive at the browser already expired.

null

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

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

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');

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 the stored userid from the session
Session::delete('userid');

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

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'));

null

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

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

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

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

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

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

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

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

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