Spec-Zone.ru › CakePHP 2.8

Класс CakeSession

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

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

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

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

  • $_cookieName protected static
    string
    Имя куки сессии
  • $_initialized protected static
    boolean
    Вызывался ли метод init в этом классе
  • $_userAgent protected static
    string
    Строка пользователя
  • $cookieLifeTime public static
    integer
    Срок действия куки
  • $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
    True, если сессия всё ещё действительна

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

  • _checkValid() protected static
    Вспомогательный метод для создания новой сессии.
  • _configureSession() protected static
    Вспомогательный метод для инициализации сессии на основе настроек ядра CakePHP.
  • _cookieName() protected static
    Получить имя куки сессии.
  • _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

    Проверяет, является ли пользовательский агент допустимым и не истекла ли сессия. Поскольку таймауты реализованы в CakeSession, он проверяет текущую статическую переменную $time относительно времени истечения сессии. Пользовательский агент проверяется только если 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
    Получить/установить пользовательский агент
  • 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 опционально 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 опционально 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 опционально 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 )

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

Параметры

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

Возвращает

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

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

Имя cookie сессии

null

$_initializedsource

protected static boolean

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

false

$_userAgentsource

protected static string

Строка пользовательского агента

''

$cookieLifeTimesource

public static integer

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

$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–2016 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.
http://api.cakephp.org/2.8/class-CakeSession.html

Spec-Zone.ru

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