CHttpSession

  $session=new CHttpSession;
  $session->open();
  $value1=$session['name1'];  // get session variable 'name1'
  $value2=$session['name2'];  // get session variable 'name2'
  foreach($session as $name=>$value) // traverse all session variables
  $session['name3']=$value3;  // set session variable 'name3'

Property Details

autoStart property

public boolean $autoStart;

whether the session should be automatically started when the session application component is initialized, defaults to true.

cookieMode property

public string getCookieMode()
public void setCookieMode(string $value)

how to use cookie to store session ID. Defaults to 'Allow'.

cookieParams property

public array getCookieParams()
public void setCookieParams(array $value)

the session cookie parameters.

count property read-only

public integer getCount()

Returns the number of items in the session.

gCProbability property

public float getGCProbability()
public void setGCProbability(float $value)

the probability (percentage) that the gc (garbage collection) process is started on every session initialization, defaults to 1 meaning 1% chance.

isStarted property read-only

public boolean getIsStarted()

whether the session has started

iterator property read-only

public CHttpSessionIterator getIterator()

Returns an iterator for traversing the session variables. This method is required by the interface IteratorAggregate.

keys property read-only

public array getKeys()

the list of session variable names

savePath property

public string getSavePath()
public void setSavePath(string $value)

the current session save path, defaults to http://php.net/session.save_path.

sessionID property

public string getSessionID()
public void setSessionID(string $value)

the current session ID

sessionName property

public string getSessionName()
public void setSessionName(string $value)

the current session name

timeout property

public integer getTimeout()
public void setTimeout(integer $value)

the number of seconds after which data will be seen as 'garbage' and cleaned up, defaults to 1440 seconds.

useCustomStorage property read-only

public boolean getUseCustomStorage()

Returns a value indicating whether to use custom session storage. This method should be overridden to return true if custom session storage handler should be used. If returning true, make sure the methods openSession, closeSession, readSession, writeSession, destroySession, and gcSession are overridden in child class, because they will be used as the callback handlers. The default implementation always return false.

useTransparentSessionID property

public boolean getUseTransparentSessionID()
public void setUseTransparentSessionID(boolean $value)

whether transparent sid support is enabled or not, defaults to false.

Method Details

add() method

public void add(mixed $key, mixed $value)

public function add($key,$value)
{
    $_SESSION[$key]=$value;
}

Adds a session variable. Note, if the specified name already exists, the old value will be removed first.

clear() method

public void clear()

public function clear()
{
    foreach(array_keys($_SESSION) as $key)
        unset($_SESSION[$key]);
}

Removes all session variables

close() method

public void close()

public function close()
{
    if(session_id()!=='')
        @session_write_close();
}

Ends the current session and store session data.

closeSession() method

public boolean closeSession()

public function closeSession()
{
    return true;
}

Session close handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

contains() method

public boolean contains(mixed $key)

public function contains($key)
{
    return isset($_SESSION[$key]);
}

count() method

public integer count()

public function count()
{
    return $this->getCount();
}

Returns the number of items in the session. This method is required by Countable interface.

destroy() method

public void destroy()

public function destroy()
{
    if(session_id()!=='')
    {
        @session_unset();
        @session_destroy();
    }
}

Frees all session variables and destroys all data registered to a session.

destroySession() method

public boolean destroySession(string $id)

public function destroySession($id)
{
    return true;
}

Session destroy handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

gcSession() method

public boolean gcSession(integer $maxLifetime)

public function gcSession($maxLifetime)
{
    return true;
}

Session GC (garbage collection) handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

get() method (available since v1.1.2)

public mixed get(mixed $key, mixed $defaultValue=NULL)

public function get($key,$defaultValue=null)
{
    return isset($_SESSION[$key]) ? $_SESSION[$key] : $defaultValue;
}

Returns the session variable value with the session variable name. This method is very similar to itemAt and offsetGet, except that it will return $defaultValue if the session variable does not exist.

getCookieMode() method

public string getCookieMode()

public function getCookieMode()
{
    if(ini_get('session.use_cookies')==='0')
        return 'none';
    elseif(ini_get('session.use_only_cookies')==='0')
        return 'allow';
    else
        return 'only';
}

getCookieParams() method

public array getCookieParams()

public function getCookieParams()
{
    return session_get_cookie_params();
}

getCount() method

public integer getCount()

public function getCount()
{
    return count($_SESSION);
}

Returns the number of items in the session.

getGCProbability() method

public float getGCProbability()

public function getGCProbability()
{
    return (float)(ini_get('session.gc_probability')/ini_get('session.gc_divisor')*100);
}

getIsStarted() method

public boolean getIsStarted()

public function getIsStarted()
{
    if(function_exists('session_status'))
        return session_status()===PHP_SESSION_ACTIVE;
    return session_id()!=='';
}

getIterator() method

public CHttpSessionIterator getIterator()

public function getIterator()
{
    return new CHttpSessionIterator;
}

Returns an iterator for traversing the session variables. This method is required by the interface IteratorAggregate.

getKeys() method

public array getKeys()

public function getKeys()
{
    return array_keys($_SESSION);
}

getSavePath() method

public string getSavePath()

public function getSavePath()
{
    return session_save_path();
}

getSessionID() method

public string getSessionID()

public function getSessionID()
{
    return session_id();
}

getSessionName() method

public string getSessionName()

public function getSessionName()
{
    return session_name();
}

getTimeout() method

public integer getTimeout()

public function getTimeout()
{
    return (int)ini_get('session.gc_maxlifetime');
}

getUseCustomStorage() method

public boolean getUseCustomStorage()

public function getUseCustomStorage()
{
    return false;
}

Returns a value indicating whether to use custom session storage. This method should be overridden to return true if custom session storage handler should be used. If returning true, make sure the methods openSession, closeSession, readSession, writeSession, destroySession, and gcSession are overridden in child class, because they will be used as the callback handlers. The default implementation always return false.

getUseTransparentSessionID() method

public boolean getUseTransparentSessionID()

public function getUseTransparentSessionID()
{
    return ini_get('session.use_trans_sid')==1;
}

init() method

public void init()

public function init()
{
    parent::init();

    if($this->autoStart)
        $this->open();
    register_shutdown_function(array($this,'close'));
}

Initializes the application component. This method is required by IApplicationComponent and is invoked by application.

itemAt() method

public mixed itemAt(mixed $key)

public function itemAt($key)
{
    return isset($_SESSION[$key]) ? $_SESSION[$key] : null;
}

Returns the session variable value with the session variable name. This method is exactly the same as offsetGet.

offsetExists() method

public boolean offsetExists(mixed $offset)

public function offsetExists($offset)
{
    return isset($_SESSION[$offset]);
}

This method is required by the interface ArrayAccess.

offsetGet() method

public mixed offsetGet(integer $offset)

public function offsetGet($offset)
{
    return isset($_SESSION[$offset]) ? $_SESSION[$offset] : null;
}

This method is required by the interface ArrayAccess.

offsetSet() method

public void offsetSet(integer $offset, mixed $item)

public function offsetSet($offset,$item)
{
    $_SESSION[$offset]=$item;
}

This method is required by the interface ArrayAccess.

offsetUnset() method

public void offsetUnset(mixed $offset)

public function offsetUnset($offset)
{
    unset($_SESSION[$offset]);
}

This method is required by the interface ArrayAccess.

open() method

public void open()

public function open()
{
    if($this->getUseCustomStorage())
        @session_set_save_handler(array($this,'openSession'),array($this,'closeSession'),array($this,'readSession'),array($this,'writeSession'),array($this,'destroySession'),array($this,'gcSession'));

    @session_start();
    if(YII_DEBUG && session_id()=='')
    {
        $message=Yii::t('yii','Failed to start session.');
        if(function_exists('error_get_last'))
        {
            $error=error_get_last();
            if(isset($error['message']))
                $message=$error['message'];
        }
        Yii::log($message, CLogger::LEVEL_WARNING, 'system.web.CHttpSession');
    }
}

Starts the session if it has not started yet.

openSession() method

public boolean openSession(string $savePath, string $sessionName)

public function openSession($savePath,$sessionName)
{
    return true;
}

Session open handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

readSession() method

public string readSession(string $id)

public function readSession($id)
{
    return '';
}

Session read handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.

regenerateID() method (available since v1.1.8)

public void regenerateID(boolean $deleteOldSession=false)

public function regenerateID($deleteOldSession=false)
{
    if($this->getIsStarted())
        session_regenerate_id($deleteOldSession);
}

Updates the current session id with a newly generated one . Please refer to http://php.net/session_regenerate_id for more details.

remove() method

public mixed remove(mixed $key)

public function remove($key)
{
    if(isset($_SESSION[$key]))
    {
        $value=$_SESSION[$key];
        unset($_SESSION[$key]);
        return $value;
    }
    else
        return null;
}

Removes a session variable.

setCookieMode() method

public void setCookieMode(string $value)

public function setCookieMode($value)
{
    if($value==='none')
    {
        ini_set('session.use_cookies','0');
        ini_set('session.use_only_cookies','0');
    }
    elseif($value==='allow')
    {
        ini_set('session.use_cookies','1');
        ini_set('session.use_only_cookies','0');
    }
    elseif($value==='only')
    {
        ini_set('session.use_cookies','1');
        ini_set('session.use_only_cookies','1');
    }
    else
        throw new CException(Yii::t('yii','CHttpSession.cookieMode can only be "none", "allow" or "only".'));
}

setCookieParams() method

public void setCookieParams(array $value)

public function setCookieParams($value)
{
    $data=session_get_cookie_params();
    extract($data);
    extract($value);
    if(isset($httponly))
        session_set_cookie_params($lifetime,$path,$domain,$secure,$httponly);
    else
        session_set_cookie_params($lifetime,$path,$domain,$secure);
}

Sets the session cookie parameters. The effect of this method only lasts for the duration of the script. Call this method before the session starts.

setGCProbability() method

public void setGCProbability(float $value)

public function setGCProbability($value)
{
    if($value>=0 && $value<=100)
    {
        // percent * 21474837 / 2147483647 ≈ percent * 0.01
        ini_set('session.gc_probability',floor($value*21474836.47));
        ini_set('session.gc_divisor',2147483647);
    }
    else
        throw new CException(Yii::t('yii','CHttpSession.gcProbability "{value}" is invalid. It must be a float between 0 and 100.',
            array('{value}'=>$value)));
}

setSavePath() method

public void setSavePath(string $value)

public function setSavePath($value)
{
    if(is_dir($value))
        session_save_path($value);
    else
        throw new CException(Yii::t('yii','CHttpSession.savePath "{path}" is not a valid directory.',
            array('{path}'=>$value)));
}

setSessionID() method

public void setSessionID(string $value)

public function setSessionID($value)
{
    session_id($value);
}

setSessionName() method

public void setSessionName(string $value)

public function setSessionName($value)
{
    session_name($value);
}

setTimeout() method

public void setTimeout(integer $value)

public function setTimeout($value)
{
    ini_set('session.gc_maxlifetime',$value);
}

setUseTransparentSessionID() method

public void setUseTransparentSessionID(boolean $value)

public function setUseTransparentSessionID($value)
{
    ini_set('session.use_trans_sid',$value?'1':'0');
}

toArray() method

public array toArray()

public function toArray()
{
    return $_SESSION;
}

writeSession() method

public boolean writeSession(string $id, string $data)

public function writeSession($id,$data)
{
    return true;
}

Session write handler. This method should be overridden if useCustomStorage is set true. Do not call this method directly.