Cookie-based session class.
Class declared in SYSPATH/classes/kohana/session/cookie.php on line 11.
string $defaultdefault session adapter
string(6) "native"array $instancessession instances
array(0) array $_datasession data
bool $_destroyedsession destroyed?
bool $_encryptedencrypt session data?
int $_lifetimecookie lifetime
string $_namecookie name
Overloads the name, lifetime, and encrypted session settings.
Sessions can only be created using the Session::instance method.
array
$config
= NULL - Configurationstring
$id
= NULL - Session idvoidpublic function __construct(array $config = NULL, $id = NULL)
{
if (isset($config['name']))
{
// Cookie name to store the session id in
$this->_name = (string) $config['name'];
}
if (isset($config['lifetime']))
{
// Cookie lifetime
$this->_lifetime = (int) $config['lifetime'];
}
if (isset($config['encrypted']))
{
if ($config['encrypted'] === TRUE)
{
// Use the default Encrypt instance
$config['encrypted'] = 'default';
}
// Enable or disable encryption of data
$this->_encrypted = $config['encrypted'];
}
// Load the session
$this->read($id);
}Session object is rendered to a serialized string. If encryption is enabled, the session will be encrypted. If not, the output string will be encoded using base64_encode.
echo $session;
stringpublic function __toString()
{
// Serialize the data array
$data = serialize($this->_data);
if ($this->_encrypted)
{
// Encrypt the data using the default key
$data = Encrypt::instance($this->_encrypted)->encode($data);
}
else
{
// Obfuscate the data with base64 encoding
$data = base64_encode($data);
}
return $data;
}Returns the current session array. The returned array can also be assigned by reference.
// Get a copy of the current session data
$data = $session->as_array();
// Assign by reference for modification
$data =& $session->as_array();
arraypublic function & as_array()
{
return $this->_data;
}Set a variable by reference.
$session->bind('foo', $foo);
string
$key
required - Variable namebyref mixed
$value
required - Referenced value$thispublic function bind($key, & $value)
{
$this->_data[$key] =& $value;
return $this;
}Removes a variable in the session array.
$session->delete('foo');
string
$key
required - ,... variable name$thispublic function delete($key)
{
$args = func_get_args();
foreach ($args as $key)
{
unset($this->_data[$key]);
}
return $this;
}Completely destroy the current session.
$success = $session->destroy();
booleanpublic function destroy()
{
if ($this->_destroyed === FALSE)
{
if ($this->_destroyed = $this->_destroy())
{
// The session has been destroyed, clear all data
$this->_data = array();
}
}
return $this->_destroyed;
}Get a variable from the session array.
$foo = $session->get('foo');
string
$key
required - Variable namemixed
$default
= NULL - Default value to returnmixedpublic function get($key, $default = NULL)
{
return array_key_exists($key, $this->_data) ? $this->_data[$key] : $default;
}Get and delete a variable from the session array.
$bar = $session->get_once('bar');
string
$key
required - Variable namemixed
$default
= NULL - Default value to returnmixedpublic function get_once($key, $default = NULL)
{
$value = $this->get($key, $default);
unset($this->_data[$key]);
return $value;
}Get the current session id, if the session supports it.
$id = $session->id();
Not all session types have ids.
stringpublic function id()
{
return NULL;
}Creates a singleton session of the given type. Some session types (native, database) also support restarting a session by passing a session id as the second parameter.
$session = Session::instance();
Session::write will automatically be called when the request ends.
string
$type
= NULL - Type of session (native, cookie, etc)string
$id
= NULL - Session identifierSessionpublic static function instance($type = NULL, $id = NULL)
{
if ($type === NULL)
{
// Use the default type
$type = Session::$default;
}
if ( ! isset(Session::$instances[$type]))
{
// Load the configuration for this type
$config = Kohana::$config->load('session')->get($type);
// Set the session class name
$class = 'Session_'.ucfirst($type);
// Create a new session instance
Session::$instances[$type] = $session = new $class($config, $id);
// Write the session at shutdown
register_shutdown_function(array($session, 'write'));
}
return Session::$instances[$type];
}Get the current session cookie name.
$name = $session->name();
stringpublic function name()
{
return $this->_name;
}Loads existing session data.
$session->read();
string
$id
= NULL - Session idvoidpublic function read($id = NULL)
{
$data = NULL;
try
{
if (is_string($data = $this->_read($id)))
{
if ($this->_encrypted)
{
// Decrypt the data using the default key
$data = Encrypt::instance($this->_encrypted)->decode($data);
}
else
{
// Decode the base64 encoded data
$data = base64_decode($data);
}
// Unserialize the data
$data = unserialize($data);
}
else
{
// Ignore these, session is valid, likely no data though.
}
}
catch (Exception $e)
{
// Error reading the session, usually
// a corrupt session.
throw new Session_Exception('Error reading session data.', NULL, Session_Exception::SESSION_CORRUPT);
}
if (is_array($data))
{
// Load the data locally
$this->_data = $data;
}
}Generates a new session id and returns it.
$id = $session->regenerate();
stringpublic function regenerate()
{
return $this->_regenerate();
}Restart the session.
$success = $session->restart();
booleanpublic function restart()
{
if ($this->_destroyed === FALSE)
{
// Wipe out the current session.
$this->destroy();
}
// Allow the new session to be saved
$this->_destroyed = FALSE;
return $this->_restart();
}Set a variable in the session array.
$session->set('foo', 'bar');
string
$key
required - Variable namemixed
$value
required - Value$thispublic function set($key, $value)
{
$this->_data[$key] = $value;
return $this;
}Sets the last_active timestamp and saves the session.
$session->write();
Any errors that occur during session writing will be logged, but not displayed, because sessions are written after output has been sent.
booleanpublic function write()
{
if (headers_sent() OR $this->_destroyed)
{
// Session cannot be written when the headers are sent or when
// the session has been destroyed
return FALSE;
}
// Set the last active timestamp
$this->_data['last_active'] = time();
try
{
return $this->_write();
}
catch (Exception $e)
{
// Log & ignore all errors when a write fails
Kohana::$log->add(Log::ERROR, Kohana_Exception::text($e))->write();
return FALSE;
}
}boolprotected function _destroy()
{
return Cookie::delete($this->_name);
}string
$id
= NULL - Session idstringprotected function _read($id = NULL)
{
return Cookie::get($this->_name, NULL);
}nullprotected function _regenerate()
{
// Cookie sessions have no id
return NULL;
}boolprotected function _restart()
{
return TRUE;
}boolprotected function _write()
{
return Cookie::set($this->_name, $this->__toString(), $this->_lifetime);
}