Класс yii\web\Session

$session = new Session;
$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'

public array getAllFlashes ( $delete = false )

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

public integer getCount ( )

public void setFlash ( $key, $value = true, $removeAfterAccess = true )

public string $flashParam = '__flash'

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

public SessionHandlerInterface|array $handler = null

public boolean getHasSessionId ( )
public void setHasSessionId ( $value )

public string getId ( )
public void setId ( $value )

public boolean getIsActive ( )

public yii\web\SessionIterator getIterator ( )

public string getName ( )
public void setName ( $value )

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

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

public boolean|null getUseCookies ( )
public void setUseCookies ( $value )

public boolean getUseCustomStorage ( )

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

addFlash() public method

Добавляет сообщение всплывающей подсказки.

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

См. также:

• getFlash()
• setFlash()
• removeFlash()

public void addFlash ( $key, $value = true, $removeAfterAccess = true )
$key	string	Ключ, идентифицирующий сообщение всплывающей подсказки.
$value	mixed	Сообщение всплывающей подсказки
$removeAfterAccess	boolean	Указывает, должно ли сообщение всплывающей подсказки автоматически удаляться только при доступе к нему. Если false, сообщение всплывающей подсказки будет автоматически удалено после следующего запроса, независимо от того, было ли к нему обращение. Если true (значение по умолчанию), сообщение всплывающей подсказки сохранится до тех пор, пока к нему не будет обращение.

close() public method

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

public void close ( )

closeSession() public method

Обработчик закрытия сессии.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public boolean closeSession ( )
return	boolean	Указывает, успешно ли закрыта сессия

count() public method

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

Этот метод требуется интерфейсом Countable.

public integer count ( )
return	integer	Количество элементов в сессии.

destroy() public method

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

Этот метод не оказывает никакого влияния, когда сессия не активна. Убедитесь, что вы вызываете open() перед его вызовом.

См. также:

• open()
• $isActive

public void destroy ( )

destroySession() public method

Обработчик уничтожения сессии.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public boolean destroySession ( $id )
$id	string	Идентификатор сессии
return	boolean	Указывает, успешно ли уничтожена сессия

gcSession() public method

Обработчик GC (уборки мусора) сессии.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public boolean gcSession ( $maxLifetime )
$maxLifetime	integer	Количество секунд, по истечении которых данные будут считаться 'мусором' и удалены.
return	boolean	Указывает, успешно ли выполнена GC сессии

get() public method

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

Если переменная сессии не существует, будет возвращено $defaultValue.

public mixed get ( $key, $defaultValue = null )
$key	string	Имя переменной сессии
$defaultValue	mixed	Значение по умолчанию, возвращаемое, если переменная сессии не существует.
return	mixed	Значение переменной сессии или $defaultValue, если переменная сессии не существует.

getAllFlashes() public method

Возвращает все сообщения всплывающей подсказки.

Вы можете использовать этот метод для отображения всех сообщений всплывающей подсказки в файле представления:

<?php
foreach (Yii::$app->session->getAllFlashes() as $key => $message) {
    echo '<div class="alert alert-' . $key . '">' . $message . '</div>';
} ?>

С помощью данного кода вы можете использовать классы bootstrap alert, такие как success, info, danger, в качестве ключа сообщения всплывающей подсказки для изменения цвета div.

Обратите внимание, что если вы используете addFlash(), $message будет массивом, и вам нужно будет изменить вышеприведенный код.

См. также:

• setFlash()
• addFlash()
• getFlash()
• hasFlash()
• removeFlash()

public array getAllFlashes ( $delete = false )
$delete	boolean	Указывает, следует ли удалить сообщения всплывающей подсказки сразу после вызова этого метода. Если false, сообщения всплывающей подсказки будут автоматически удалены в следующем запросе.
return	array	Сообщения всплывающей подсказки (ключ => сообщение или ключ => [сообщение1, сообщение2]).

getCookieParams() public method

См. также http://php.net/manual/en/function.session-get-cookie-params.php.

public array getCookieParams ( )
return	array	Параметры cookie сессии.

getCount() public method

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

public integer getCount ( )
return	integer	Количество переменных сессии

getFlash() public method

Возвращает сообщение всплывающей подсказки.

См. также:

• setFlash()
• addFlash()
• hasFlash()
• getAllFlashes()
• removeFlash()

public mixed getFlash ( $key, $defaultValue = null, $delete = false )
$key	string	Ключ, идентифицирующий сообщение всплывающей подсказки
$defaultValue	mixed	Значение, которое будет возвращено, если сообщение всплывающей подсказки не существует.
$delete	boolean	Указывает, нужно ли удалить это сообщение всплывающей подсказки сразу после вызова этого метода. Если false, сообщение всплывающей подсказки будет автоматически удалено в следующем запросе.
return	mixed	Сообщение всплывающей подсказки или массив сообщений, если использовался addFlash

getGCProbability() public method

public float getGCProbability ( )
return	float	Вероятность (процент) того, что процесс GC (уборки мусора) будет запущен при каждом инициализации сессии, по умолчанию 1, что означает 1% шанс.

getHasSessionId() public method

Возвращает значение, указывающее, отправлен ли идентификатор сессии текущим запросом.

Реализация по умолчанию проверяет cookie и $_GET с использованием имени сессии. Если вы отправляете идентификатор сессии другими способами, вам может потребоваться переопределить этот метод или вызвать setHasSessionId(), чтобы явно указать, отправлен ли идентификатор сессии.

public boolean getHasSessionId ( )
return	boolean	Отправлен ли идентификатор сессии текущим запросом.

getId() public method

Получение идентификатора сессии.

Это обёртка для PHP session_id().

public string getId ( )
return	string	Текущий идентификатор сессии

getIsActive() public method

public boolean getIsActive ( )
return	boolean	Началась ли сессия

getIterator() public method

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

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

public yii\web\SessionIterator getIterator ( )
return	yii\web\SessionIterator	Итератор для перебора переменных сессии.

getName() public method

Получение имени текущей сессии.

Это обёртка для PHP session_name().

public string getName ( )
return	string	Текущее имя сессии

getSavePath() public method

Получение текущего пути сохранения сессии.

Это обёртка для PHP session_save_path().

public string getSavePath ( )
return	string	Текущий путь сохранения сессии, по умолчанию — '/tmp'.

getTimeout() public method

public integer getTimeout ( )
return	integer	Количество секунд, после которого данные будут считаться «мусором» и удалены. Значение по умолчанию — 1440 секунд (или значение «session.gc_maxlifetime», заданное в php.ini).

getUseCookies() public method

Возвращает значение, указывающее, следует ли использовать куки для хранения идентификаторов сессии.

См. также setUseCookies().

public boolean|null getUseCookies ( )
return	boolean|null	Значение, указывающее, следует ли использовать куки для хранения идентификаторов сессии.

getUseCustomStorage() public method

Возвращает значение, указывающее, следует ли использовать пользовательское хранилище сессий.

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

public boolean getUseCustomStorage ( )
return	boolean	Использовать ли пользовательское хранилище.

getUseTransparentSessionID() public method

public boolean getUseTransparentSessionID ( )
return	boolean	Включена ли поддержка прозрачного идентификатора сессии, по умолчанию — false.

has() public method

public boolean has ( $key )
$key	mixed	Имя переменной сессии
return	boolean	Существует ли переменная сессии с данным именем

hasFlash() public method

Возвращает значение, указывающее, существуют ли сообщения всплывающей подсказки, связанные с указанным ключом.

public boolean hasFlash ( $key )
$key	string	Ключ, определяющий тип сообщения всплывающей подсказки
return	boolean	Существуют ли сообщения всплывающей подсказки под указанным ключом

init() public method

Инициализация компонента приложения.

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

public void init ( )

offsetExists() public method

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

public boolean offsetExists ( $offset )
$offset	mixed	Проверяемый индекс

offsetGet() public method

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

public mixed offsetGet ( $offset )
$offset	integer	Индекс для получения элемента.
return	mixed	Элемент по индексу, null, если элемент не найден

offsetSet() public method

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

public void offsetSet ( $offset, $item )
$offset	integer	Индекс для записи элемента
$item	mixed	Значение элемента

offsetUnset() public method

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

public void offsetUnset ( $offset )
$offset	mixed	Индекс для удаления элемента

open() public method

Начало сессии.

public void open ( )

openSession() public method

Обработчик открытия сессии.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public boolean openSession ( $savePath, $sessionName )
$savePath	string	Путь сохранения сессии
$sessionName	string	Имя сессии
return	boolean	Успешно ли открыта сессия

readSession() public method

Обработчик чтения сессии.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public string readSession ( $id )
$id	string	Идентификатор сессии
return	string	Данные сессии

regenerateID() public method

Обновляет текущий идентификатор сессии на новый сгенерированный.

Для получения дополнительной информации обратитесь к http://php.net/session_regenerate_id.

Этот метод не имеет эффекта, когда сессия не активна. Убедитесь, что вы вызвали open() перед его вызовом.

См. также:

• open()
• $isActive

public void regenerateID ( $deleteOldSession = false )
$deleteOldSession	boolean	Удалить ли старый файл сессии.

registerSessionHandler() protected method

Регистрирует обработчик сессии.

protected void registerSessionHandler ( )
throws	yii\base\InvalidConfigException

remove() public method

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

public mixed remove ( $key )
$key	string	Имя переменной сессии, которую нужно удалить
return	mixed	Удаленное значение, null, если такой переменной не существует.

removeAll() public method

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

public void removeAll ( )

removeAllFlashes() public method

Удаляет все сообщения всплывающих сообщений.

Обратите внимание, что сообщения всплывающих сообщений и обычные переменные сессии используют одно и то же пространство имен. Если у вас есть обычная переменная сессии с тем же именем, она будет удалена этим методом.

См. также:

• getFlash()
• setFlash()
• addFlash()
• removeFlash()

public void removeAllFlashes ( )

removeFlash() public method

Удаляет сообщение всплывающего сообщения.

См. также:

• getFlash()
• setFlash()
• addFlash()
• removeAllFlashes()

public mixed removeFlash ( $key )
$key	string	Ключ, определяющий сообщение всплывающего сообщения. Обратите внимание, что сообщения всплывающих сообщений и обычные переменные сессии используют одно и то же пространство имен. Если у вас есть обычная переменная сессии с тем же именем, ее значение будет удалено этим методом.
return	mixed	Удаленное сообщение всплывающего сообщения. Null, если сообщение всплывающего сообщения не существует.

set() public method

Добавляет переменную сессии.

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

public void set ( $key, $value )
$key	string	Имя переменной сессии
$value	mixed	Значение переменной сессии

setCookieParams() public method

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

Параметры cookie, переданные в этот метод, будут объединены с результатом session_get_cookie_params().

См. также http://us2.php.net/manual/en/function.session-set-cookie-params.php.

public void setCookieParams ( array $value )
$value	array	Параметры Cookie, допустимые ключи включают: lifetime, path, domain, secure и httponly.
throws	yii\base\InvalidParamException	если параметры неполные.

setFlash() public method

Устанавливает всплывающее сообщение.

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

См. также:

• getFlash()
• addFlash()
• removeFlash()

public void setFlash ( $key, $value = true, $removeAfterAccess = true )
$key	string	Ключ, определяющий сообщение всплывающего сообщения. Обратите внимание, что сообщения всплывающих сообщений и обычные переменные сессии используют одно и то же пространство имен. Если у вас есть обычная переменная сессии с тем же именем, ее значение будет перезаписано этим методом.
$value	mixed	Всплывающее сообщение
$removeAfterAccess	boolean	Удалить ли всплывающее сообщение автоматически только при доступе к нему. Если false, всплывающее сообщение будет удалено автоматически после следующего запроса независимо от того, был ли к нему доступ или нет. Если true (значение по умолчанию), всплывающее сообщение останется до тех пор, пока к нему не будет получен доступ.

setGCProbability() public method

public void setGCProbability ( $value )
$value	float	Вероятность (процент), что процесс GC (сбор мусора) запускается при каждом инициализации сессии.
throws	yii\base\InvalidParamException	если значение не находится между 0 и 100.

setHasSessionId() public method

Устанавливает значение, указывающее, отправил ли текущий запрос идентификатор сессии.

Этот метод предоставляется для того, чтобы вы могли переопределить стандартный способ определения того, отправлен ли идентификатор сессии.

public void setHasSessionId ( $value )
$value	boolean	Отправил ли текущий запрос идентификатор сессии.

setId() public method

Устанавливает идентификатор сессии.

Это обёртка для PHP session_id().

public void setId ( $value )
$value	string	Идентификатор сессии для текущей сессии

setName() public method

Устанавливает имя для текущей сессии.

Это обёртка для PHP session_name().

public void setName ( $value )
$value	string	Имя сессии для текущей сессии, должно быть строкой из буквенно-цифровых символов. По умолчанию равно "PHPSESSID".

setSavePath() public method

Устанавливает текущий путь сохранения сессии.

Это обёртка для PHP session_save_path().

public void setSavePath ( $value )
$value	string	Текущий путь сохранения сессии. Может быть именем каталога или псевдонимом пути.
throws	yii\base\InvalidParamException	если путь не является допустимым каталогом

setTimeout() public method

public void setTimeout ( $value )
$value	integer	Количество секунд, по истечении которых данные будут считаться 'мусором' и удалены

setUseCookies() public method

Устанавливает значение, указывающее, следует ли использовать куки для хранения идентификаторов сеанса.

Возможны три состояния:

• true: будут использоваться только куки для хранения идентификаторов сеанса.
• false: куки не будут использоваться для хранения идентификаторов сеанса.
• null: если возможно, будут использоваться куки для хранения идентификаторов сеанса; если нет, будут использоваться другие механизмы (например, параметр GET).

public void setUseCookies ( $value )
$value	boolean|null	Значение, указывающее, следует ли использовать куки для хранения идентификаторов сеанса.

setUseTransparentSessionID() public method

public void setUseTransparentSessionID ( $value )
$value	boolean	Включена ли поддержка прозрачного sid.

updateFlashCounters() protected method

Обновляет счетчики для всплывающих сообщений и удаляет устаревшие всплывающие сообщения.

Этот метод должен вызываться только один раз в init().

protected void updateFlashCounters ( )

writeSession() public method

Обработчик записи сеанса.

Этот метод должен быть переопределен, если $useCustomStorage возвращает true.

public boolean writeSession ( $id, $data )
$id	string	Идентификатор сеанса
$data	string	Данные сеанса
return	boolean	Успешна ли запись сеанса