public __construct( [ array $config = NULL , string $id = NULL ] ) (defined in Kohana_Session) link to this

Parameters

• array $config = NULL - Configuration
• string $id = NULL - Session id

Tags

• Uses - Session::read

Return Values

• void

?
public 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);
}

public __toString( ) (defined in Kohana_Session) link to this

?
echo $session;

Tags

• Uses - Encrypt::encode

Return Values

• string

?
public 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;
}

public as_array( ) (defined in Kohana_Session) link to this

?
// Get a copy of the current session data
$data = $session->as_array();
 
// Assign by reference for modification
$data =& $session->as_array();

Return Values

• array

?
public function & as_array()
{
    return $this->_data;
}

public bind( string $key , mixed & $value ) (defined in Kohana_Session) link to this

?
$session->bind('foo', $foo);

Parameters

• string $key required - Variable name
• byref mixed $value required - Referenced value

Return Values

• $this

?
public function bind($key, & $value)
{
    $this->_data[$key] =& $value;
 
    return $this;
}

public delete( string $key ) (defined in Kohana_Session) link to this

?
$session->delete('foo');

Parameters

• string $key required - ,... variable name

Return Values

• $this

?
public function delete($key)
{
    $args = func_get_args();
 
    foreach ($args as $key)
    {
        unset($this->_data[$key]);
    }
 
    return $this;
}

public destroy( ) (defined in Kohana_Session) link to this

?
$success = $session->destroy();

Return Values

• boolean

?
public 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;
}

public get( string $key [, mixed $default = NULL ] ) (defined in Kohana_Session) link to this

?
$foo = $session->get('foo');

Parameters

• string $key required - Variable name
• mixed $default = NULL - Default value to return

Return Values

• mixed

?
public function get($key, $default = NULL)
{
    return array_key_exists($key, $this->_data) ? $this->_data[$key] : $default;
}

public get_once( string $key [, mixed $default = NULL ] ) (defined in Kohana_Session) link to this

?
$bar = $session->get_once('bar');

Parameters

• string $key required - Variable name
• mixed $default = NULL - Default value to return

Return Values

• mixed

?
public function get_once($key, $default = NULL)
{
    $value = $this->get($key, $default);
 
    unset($this->_data[$key]);
 
    return $value;
}

public id( ) (defined in Kohana_Session) link to this

?
$id = $session->id();

Tags

• Since - 3.0.8

Return Values

• string

?
public function id()
{
    return NULL;
}

public static instance( [ string $type = NULL , string $id = NULL ] ) (defined in Kohana_Session) link to this

?
$session = Session::instance();

Parameters

• string $type = NULL - Type of session (native, cookie, etc)
• string $id = NULL - Session identifier

Tags

• Uses - Kohana::$config

Return Values

• Session

?
public 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];
}

public name( ) (defined in Kohana_Session) link to this

?
$name = $session->name();

Tags

• Since - 3.0.8

Return Values

• string

?
public function name()
{
    return $this->_name;
}

public read( [ string $id = NULL ] ) (defined in Kohana_Session) link to this

?
$session->read();

Parameters

• string $id = NULL - Session id

Return Values

• void

?
public 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;
    }
}

public regenerate( ) (defined in Kohana_Session) link to this

?
$id = $session->regenerate();

Return Values

• string

?
public function regenerate()
{
    return $this->_regenerate();
}

public restart( ) (defined in Kohana_Session) link to this

?
$success = $session->restart();

Return Values

• boolean

?
public 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();
}

public set( string $key , mixed $value ) (defined in Kohana_Session) link to this

?
$session->set('foo', 'bar');

Parameters

• string $key required - Variable name
• mixed $value required - Value

Return Values

• $this

?
public function set($key, $value)
{
    $this->_data[$key] = $value;
 
    return $this;
}

public write( ) (defined in Kohana_Session) link to this

?
$session->write();

Tags

• Uses - Kohana::$log

Return Values

• boolean

?
public 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;
    }
}

abstract protected _destroy( ) (defined in Kohana_Session) link to this

Return Values

• boolean

?
abstract protected function _destroy();

abstract protected _read( [ string $id = NULL ] ) (defined in Kohana_Session) link to this

Parameters

• string $id = NULL - Session id

Return Values

• string

?
abstract protected function _read($id = NULL);

abstract protected _regenerate( ) (defined in Kohana_Session) link to this

Return Values

• string

?
abstract protected function _regenerate();

abstract protected _restart( ) (defined in Kohana_Session) link to this

Return Values

• boolean

?
abstract protected function _restart();

abstract protected _write( ) (defined in Kohana_Session) link to this

Return Values

• boolean

?
abstract protected function _write();