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'

Подробное описание свойств

autoStart свойство

public boolean $autoStart;

Указывает, должна ли сессия автоматически запускаться при инициализации компонента приложения сессии. По умолчанию true.

cookieMode свойство

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

Способ использования cookie для хранения ID сессии. По умолчанию «Allow».

cookieParams свойство

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

Параметры cookie сессии.

count свойство только для чтения

public integer getCount()

Возвращает количество элементов в сессии.

gCProbability свойство

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

Вероятность (в процентах) запуска процесса gc (уборки мусора) при каждой инициализации сессии. По умолчанию 1 (1% вероятность).

isStarted свойство только для чтения

public boolean getIsStarted()

Указывает, была ли начата сессия.

iterator свойство только для чтения

public CHttpSessionIterator getIterator()

Возвращает итератор для перебора переменных сессии. Этот метод требуется интерфейсом IteratorAggregate.

keys свойство только для чтения

public array getKeys()

Список имён переменных сессии.

savePath свойство

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

Текущий путь сохранения сессии. По умолчанию http://php.net/session.save_path.

sessionID свойство

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

Текущий идентификатор сессии.

sessionName свойство

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

Текущее имя сессии.

timeout свойство

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

Количество секунд, по истечении которых данные будут считаться «мусором» и удалены. По умолчанию 1440 секунд.

useCustomStorage свойство только для чтения

public boolean getUseCustomStorage()

Возвращает значение, указывающее, использовать ли пользовательское хранилище сессий. Этот метод следует переопределить, чтобы вернуть true, если необходимо использовать пользовательский обработчик хранения сессий. Если возвращается true, убедитесь, что методы openSession, closeSession, readSession, writeSession, destroySession и gcSession переопределены в дочернем классе, так как они будут использоваться в качестве обработчиков обратного вызова. По умолчанию возвращает false.

useTransparentSessionID свойство

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

Указывает, включена ли поддержка прозрачного sid. По умолчанию false.

Подробное описание методов

add() метод

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

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

Добавляет переменную сессии. Если имя уже существует, старое значение будет удалено.

clear() метод

public void clear()

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

Удаляет все переменные сессии.

close() метод

public void close()

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

Завершает текущую сессию и сохраняет данные сессии.

closeSession() метод

public boolean closeSession()

public function closeSession()
{
    return true;
}

Обработчик закрытия сессии. Этот метод следует переопределить, если useCustomStorage установлен в true. Не вызывать этот метод напрямую.

contains() метод

public boolean contains(mixed $key)

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

count() метод

public integer count()

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

Возвращает количество элементов в сессии. Этот метод необходим для интерфейса Countable.

destroy() метод

public void destroy()

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

Освобождает все переменные сессии и уничтожает все данные, зарегистрированные в сессии.

destroySession() метод

public boolean destroySession(string $id)

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

Обработчик уничтожения сессии. Этот метод следует переопределить, если useCustomStorage установлен в true. Не вызывать этот метод напрямую.

gcSession() метод

public boolean gcSession(integer $maxLifetime)

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

Обработчик GC (garbage collection) сессии. Этот метод должен быть переопределён, если useCustomStorage установлен в true. Не вызывать этот метод напрямую.

get() метод (доступен с версии v1.1.2)

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

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

Возвращает значение переменной сессии по имени переменной сессии. Этот метод очень похож на itemAt и offsetGet, за исключением того, что он вернёт $defaultValue, если переменная сессии не существует.

getCookieMode() метод

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() метод

public array getCookieParams()

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

getCount() метод

public integer getCount()

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

Возвращает количество элементов в сессии.

getGCProbability() метод

public float getGCProbability()

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

getIsStarted() метод

public boolean getIsStarted()

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

getIterator() метод

public CHttpSessionIterator getIterator()

public function getIterator()
{
    return new CHttpSessionIterator;
}

Возвращает итератор для обхода переменных сессии. Этот метод необходим для интерфейса IteratorAggregate.

getKeys() метод

public array getKeys()

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

getSavePath() метод

public string getSavePath()

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

getSessionID() метод

public string getSessionID()

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

getSessionName() метод

public string getSessionName()

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

getTimeout() метод

public integer getTimeout()

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

getUseCustomStorage() метод

public boolean getUseCustomStorage()

public function getUseCustomStorage()
{
    return false;
}

Возвращает значение, указывающее, следует ли использовать пользовательское хранилище сессий. Этот метод должен быть переопределён, чтобы вернуть true, если необходимо использовать пользовательский обработчик хранилища сессий. Если возвращено true, убедитесь, что методы openSession, closeSession, readSession, writeSession, destroySession и gcSession переопределены в дочернем классе, так как они будут использоваться как обработчики обратного вызова. По умолчанию всегда возвращает false.

getUseTransparentSessionID() метод

public boolean getUseTransparentSessionID()

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

init() метод

public void init()

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

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

Инициализирует компонент приложения. Этот метод необходим для IApplicationComponent и вызывается приложением.

itemAt() метод

public mixed itemAt(mixed $key)

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

Возвращает значение переменной сессии по имени переменной сессии. Этот метод идентичен методу offsetGet.

offsetExists() метод

public boolean offsetExists(mixed $offset)

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

Этот метод необходим для интерфейса ArrayAccess.

offsetGet() метод

public mixed offsetGet(integer $offset)

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

Этот метод необходим для интерфейса ArrayAccess.

offsetSet() метод

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

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

Этот метод необходим для интерфейса ArrayAccess.

offsetUnset() метод

public void offsetUnset(mixed $offset)

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

Этот метод необходим для интерфейса ArrayAccess.

open() метод

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

Начинает сеанс, если он еще не начат.

openSession() метод

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

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

Обработчик открытия сессии. Этот метод следует переопределять, если useCustomStorage установлен в true. Не вызывайте этот метод напрямую.

readSession() метод

public string readSession(string $id)

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

Обработчик чтения сессии. Этот метод следует переопределять, если useCustomStorage установлен в true. Не вызывайте этот метод напрямую.

regenerateID() метод (доступен с версии 1.1.8)

public void regenerateID(boolean $deleteOldSession=false)

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

Обновляет текущий идентификатор сессии на новый сгенерированный. Подробнее см. http://php.net/session_regenerate_id.

remove() метод

public mixed remove(mixed $key)

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

Удаляет переменную сессии.

setCookieMode() метод

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() метод

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

Устанавливает параметры cookie сессии. Действие этого метода действует только в течение выполнения скрипта. Вызовите этот метод до начала сессии.

setGCProbability() метод

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() метод

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() метод

public void setSessionID(string $value)

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

setSessionName() метод

public void setSessionName(string $value)

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

setTimeout() метод

public void setTimeout(integer $value)

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

setUseTransparentSessionID() метод

public void setUseTransparentSessionID(boolean $value)

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

toArray() метод

public array toArray()

public function toArray()
{
    return $_SESSION;
}

writeSession() метод

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

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

Обработчик записи сессии. Этот метод необходимо переопределить, если useCustomStorage установлен в значение true. Не вызывать этот метод напрямую.