Класс CakeSession

_checkValidисходный код защищенный статический

_checkValid( )

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

_configureSessionисходный код защищенный статический

_configureSession( )

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

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

Исключения

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

_cookieNameисходный код защищенный статический

_cookieName( )

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

Возвращаемое значение

string
строка

_defaultConfigисходный код защищенный статический

_defaultConfig( string $name )

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

Параметры

строка $name

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

Возвращаемое значение

boolean|array
лог. значение|массив

_errorисходный код защищенный статический

_error( integer $errorNumber )

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

Параметры

целое число $errorNumber

Ошибка для установки

Возвращаемое значение

string
Ошибка в виде строки

_getHandlerисходный код защищенный статический

_getHandler( string $handler )

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

Параметры

строка $handler

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

Исключения

CakeSessionException
CakeSessionException

_hasSessionисходный код защищенный статический

_hasSession( )

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

Возвращаемое значение

boolean
лог. значение

_overwriteисходный код защищенный статический

_overwrite( array $old , array $new )

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

Параметры

массив $old

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

массив $new

Новый набор переменных => значение

_returnSessionVarsисходный код защищенный статический

_returnSessionVars( )

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

Возвращаемое значение

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

_setErrorисходный код защищенный статический

_setError( integer $errorNumber , string $errorMessage )

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

Параметры

целое число $errorNumber

Номер ошибки

строка $errorMessage

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

_setHostисходный код защищенный статический

_setHost( string $host )

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

Параметры

строка $host

Имя хоста

_setPathисходный код защищенный статический

_setPath( string|null $base null )

Настройка переменной Path

Параметры

строка|null $base необязательно null

базовый путь

_startSessionисходный код защищенный статический

_startSession( )

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

Возвращаемое значение

boolean
Успех

_validAgentAndTimeисходный код защищенный статический

_validAgentAndTime( )

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

Возвращаемое значение

boolean
лог. значение

_writeConfigисходный код защищенный статический

_writeConfig( )

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

checkисходный код публичный статический

check( string $name )

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

Параметры

строка $name

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

Возвращаемое значение

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

clearисходный код публичный статический

clear( boolean $renew true )

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

Необязательно также очищает идентификатор сессии и обновляет сессию.

Параметры

логическое значение $renew необязательно true

Если сессия также должна быть обновлена. По умолчанию - истина.

consumeисходный код публичный статический

consume( string $name )

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

Параметры

строка $name

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

Возвращаемое значение

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

deleteисходный код публичный статический

delete( string $name )

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

Параметры

строка $name

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

Возвращаемое значение

boolean
Успех

destroyисходный код публичный статический

destroy( )

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

errorsource public static

error( )

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

Возвращает

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

idsource public static

id( string|null $id null )

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

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

Параметры

string|null $id необязательно null

Идентификатор для замены текущего идентификатора сессии

Возвращает

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

initsource public static

init( string|null $base null )

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

Параметры

string|null $base необязательно null

Базовая директория для сессии

readsource public static

read( string|null $name null )

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

Параметры

string|null $name необязательно null

Имя переменной сессии (или путь, как в Set.extract)

Возвращает

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

renewsource public static

renew( )

Перезапускает сессию.

startsource public static

start( )

Запускает сессию.

Возвращает

boolean
True, если сессия была запущена

startedsource public static

started( )

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

Возвращает

boolean
True, если сессия была запущена.

userAgentsource public static

userAgent( string|null $userAgent null )

Получить/установить пользовательский агент

Параметры

string|null $userAgent необязательно null

Установить пользовательский агент

Возвращает

string
Текущий пользовательский агент.

validsource public static

valid( )

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

Возвращает

boolean
Успех

writesource public static

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

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

Параметры

string|array $name

Имя переменной

string $value необязательно null

Значение для записи

Возвращает

boolean
True, если запись выполнена успешно, false — при ошибке записи

null

false

''

false

null

null

null

'/'

10

false

false

null

false