Spec-Zone.ru › CakePHP 2.10

Класс CakeSession

Класс сессии для CakePHP.

CakePHP абстрагирует обработку сессий. Существуют удобные методы для доступа к информации о сессии. Этот класс реализует эти методы. Они в основном используются компонентом Session.

Пакет: Cake\Модель\Источник данных
Авторское право: Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
Лицензия: MIT Лицензия
Расположение: Cake/Model/Datasource/CakeSession.php

Краткое описание свойств

  • $_cookieName protected static
    string
    Имя cookie сессии
  • $_initialized protected static
    boolean
    Выполнен ли метод init() в этом классе
  • $_userAgent protected static
    string
    Строка user agent
  • $cookieLifeTime public static
    integer
    Срок действия cookie
  • $error public static
    array
    Сообщения об ошибках для этой сессии
  • $host public static
    string
    Имя хоста
  • $id public static
    string
    Текущий идентификатор сессии
  • $lastError public static
    integer
    Номер ошибки последней возникшей ошибки
  • $path public static
    string
    Путь, где активна сессия.
  • $requestCountdown public static
    integer

    Количество запросов, которые могут произойти во время времени сессии, без ее возобновления. Эта функция используется только при установке значения конфигурации Session.autoRegenerate в true.

  • $sessionTime public static
    integer
    Время, когда эта сессия становится недействительной.
  • $time public static
    integer
    Время начала этой сессии.
  • $timeout public static
    integer
    Множитель коэффициента таймаута сессии
  • $valid public static
    boolean
    Истина, если сессия все еще действительна

Краткое описание методов

  • _checkValid() protected static
    Вспомогательный метод для создания новой сессии.
  • _configureSession() protected static
    Вспомогательный метод для инициализации сессии на основе настроек ядра CakePHP.
  • _cookieName() protected static
    Получить имя cookie сессии.
  • _defaultConfig() protected static
    Получить одну из предварительно подготовленных конфигураций сессии по умолчанию.
  • _error() protected static
    Возвращает описание ошибки для заданного номера ошибки.
  • _getHandler() protected static
    Найти класс обработчика и убедиться, что он реализует правильный интерфейс.
  • _hasSession() protected static
    Возвращает, существует ли сессия
  • _overwrite() protected static
    Используется для записи новых данных в _SESSION, так как PHP не разрешает нам устанавливать переменную _SESSION напрямую.
  • _returnSessionVars() protected static
    Возвращает все переменные сессии.
  • _setError() protected static
    Вспомогательный метод для установки внутреннего сообщения об ошибке.
  • _setHost() protected static
    Установить имя хоста
  • _setPath() protected static
    Настроить переменную Path
  • _startSession() protected static
    Вспомогательный метод для запуска сессии
  • _validAgentAndTime() protected static

    Проверяет, является ли user agent допустимым и не истек ли срок действия сессии. Так как таймауты реализованы в CakeSession, проверяет текущую static::$time по отношению к времени, когда сессия должна истечь. User agent проверяется только если Session.checkAgent == true.

  • _writeConfig() protected static
    Записывает переменные конфигурации в сессию
  • check() public static
    Возвращает true, если заданная переменная установлена в сессии.
  • clear() public static
    Очищает сессию.
  • consume() public static
    Читает и удаляет переменную из сессии.
  • delete() public static
    Удаляет переменную из сессии.
  • destroy() public static
    Вспомогательный метод для уничтожения недействительных сессий.
  • error() public static
    Возвращает последнюю возникшую ошибку в виде строки, если есть.
  • id() public static

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

  • init() public static
    Псевдоконструктор.
  • read() public static
    Возвращает заданную переменную сессии или все переменные, если параметры не указаны.
  • renew() public static
    Перезапускает эту сессию.
  • start() public static
    Запускает сессию.
  • started() public static
    Определить, была ли запущена сессия.
  • userAgent() public static
    Получить/установить user agent
  • valid() public static
    Возвращает true, если сессия действительна.
  • write() public static
    Записывает значение в заданную переменную сессии.

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

_checkValid()исходный код protected static 

_checkValid( )

Вспомогательный метод для создания новой сессии.

END_OF_DOCUMENT_MARKER

_configureSession()source protected static 

_configureSession( )

Вспомогательный метод для инициализации сессии на основе настроек ядра CakePHP.

Сессии могут быть настроены с помощью нескольких сокращенных имен, а также любым количеством параметров ini.

Возможные исключения

CakeSessionException
Выбрасывает исключения, когда ini_set() терпит неудачу.

_cookieName()source protected static 

_cookieName( )

Получить имя куки сессии.

Возвращает

string

_defaultConfig()source protected static 

_defaultConfig( string $name )

Получить одну из предварительно настроенных конфигураций сессии по умолчанию.

Параметры

string $name
Имя конфигурации.

Возвращает

boolean|array

_error()source protected static 

_error( integer $errorNumber )

Возвращает описание ошибки для заданного кода ошибки.

Параметры

integer $errorNumber
Код ошибки

Возвращает

string
Описание ошибки

_getHandler()source protected static 

_getHandler( string $handler )

Находит класс обработчика и проверяет, что он реализует соответствующий интерфейс.

Параметры

string $handler
Имя обработчика.

Возможные исключения

CakeSessionException

_hasSession()source protected static 

_hasSession( )

Возвращает, существует ли сессия.

Возвращает

boolean

_overwrite()source protected static 

_overwrite( array $old , array $new )

Используется для записи новых данных в _SESSION, так как PHP не позволяет напрямую устанавливать переменную _SESSION.

Параметры

array $old
$old Набор старых переменных => значения
array $new
Новый набор переменных => значение

_returnSessionVars()source protected static 

_returnSessionVars( )

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

Возвращает

mixed
Полный массив $_SESSION или false при ошибке.

_setError()source protected static 

_setError( integer $errorNumber , string $errorMessage )

Вспомогательный метод для установки внутреннего сообщения об ошибке.

Параметры

integer $errorNumber
Код ошибки
string $errorMessage
Описание ошибки

_setHost()source protected static 

_setHost( string $host )

Установить имя хоста

Параметры

string $host
Имя хоста

_setPath()source protected static 

_setPath( string|null $base null )

Настроить переменную Path

Параметры

string|null $base optional null
базовый путь

_startSession()source protected static 

_startSession( )

Вспомогательный метод для запуска сессии

Возвращает

boolean
Результат

_validAgentAndTime()source protected static 

_validAgentAndTime( )

Проверяет, что пользовательский агент действителен и что сессия не истекла. Так как таймауты реализованы в CakeSession, она сравнивает текущее значение static::$time с временем истечения сессии. Пользовательский агент проверяется только если Session.checkAgent == true.

Возвращает

boolean

_writeConfig()source protected static 

_writeConfig( )

Записывает переменные конфигурации в сессию

check()source public static 

check( string $name )

Возвращает true, если заданная переменная установлена в сессии.

Параметры

string $name
Имя переменной для проверки

Возвращает

boolean
True, если переменная существует

clear()source public static 

clear( boolean $renew true )

Очищает сессию.

При необходимости также очищает идентификатор сессии и обновляет сессию.

Параметры

boolean $renew optional true
Обновить ли сессию. По умолчанию true.

consume()source public static 

consume( string $name )

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

Параметры

string $name
Ключ для чтения и удаления (или путь, передаваемый в Hash.extract).

Возвращает

mixed

Значение переменной сессии, null, если сессия недоступна, не начата или указанное имя не найдено в сессии.


delete()source public static 

delete( string $name )

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

Параметры

string $name
Переменная сессии для удаления

Возвращает

boolean
Результат

destroy()source public static 

destroy( )

Вспомогательный метод для уничтожения недействительных сессий.

error()source public static 

error( )

Возвращает последнюю ошибку в виде строки, если она произошла.

Возвращает

mixed
Описание ошибки в виде строки или false.

id()source public static 

id( string|null $id null )

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

Передача идентификатора позволяет также заменить идентификатор сессии, если сессия еще не начата. Обратите внимание, что в зависимости от обработчика сессии не все символы разрешены в идентификаторе сессии. Например, обработчик файла сессий разрешает только символы в диапазоне a-z A-Z 0-9 , (запятая) и - (минус).

Параметры

string|null $id optional null
Идентификатор для замены текущего идентификатора сессии

Возвращает

string
Идентификатор сессии
END_OF_DOCUMENT_MARKER

init()source public static 

init( string|null $base null )

Псевдоконструктор.

Параметры

string|null $base необязательный null
Базовый путь для сеанса

read()source public static 

read( string|null $name null )

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

Параметры

string|null $name необязательный null
Имя переменной сеанса (или путь, как передаваемый в Set.extract)

Возвращает

mixed

Значение переменной сеанса, null, если сеанс недоступен, не начат или заданное имя не найдено в сеансе, false в случае неудачи.


renew()source public static 

renew( )

Перезапускает этот сеанс.

start()source public static 

start( )

Начинает сеанс.

Возвращает

boolean
True, если сеанс был начат

started()source public static 

started( )

Определяет, был ли начат сеанс.

Возвращает

boolean
True, если сеанс был начат.

userAgent()source public static 

userAgent( string|null $userAgent null )

Получить/Установить user agent

Параметры

string|null $userAgent необязательный null
Установить user agent

Возвращает

string
Текущий user agent.

valid()source public static 

valid( )

Возвращает true, если сеанс действителен.

Возвращает

boolean
Успех

write()source public static 

write( string|array $name , string $value null )

Записывает значение в заданную переменную сеанса.

Параметры

string|array $name
Имя переменной
string $value необязательный null
Значение для записи

Возвращает

boolean
True, если запись была успешной, false в случае неудачи

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

$_cookieNamesource

protected static string

Имя куки сеанса

null

$_initializedsource

protected static boolean

Была ли вызвана функция init() в этом классе?

false

$_userAgentsource

protected static string

Строка user agent

''

$cookieLifeTimesource

public static integer

Срок действия куки

$errorsource

public static array

Сообщения об ошибках для этого сеанса

false

$hostsource

public static string

Имя хоста

null

$idsource

public static string

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

null

$lastErrorsource

public static integer

Код ошибки последней произошедшей ошибки

null

$pathsource

public static string

Путь, где сеанс активен.

'/'

$requestCountdownsource

public static integer

Количество запросов, которые могут произойти во время сеанса без его обновления. Эта функция используется только тогда, когда значение конфигурации Session.autoRegenerate установлено в true.

См. также

CakeSession::_checkValid()
10

$sessionTimesource

public static integer

Время, когда этот сеанс станет недействительным.

false

$timesource

public static integer

Время начала сеанса.

false

$timeoutsource

public static integer

Коэффициент множителя таймаута сеанса

null

$validsource

public static boolean

True, если сеанс все еще действителен

false

© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/2.10/class-CakeSession.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API