Spec-Zone.ru › CakePHP 2.9

Класс CakeSession

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

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

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

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

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

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

  • _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

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

Получение имени cookie сессии.

Возвращает

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
Набор старых переменных и их значений
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
Идентификатор сессии

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

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

null

$_initializedsource

protected static boolean

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

false

$_userAgentsource

protected static string

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

''

$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–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.
https://api.cakephp.org/2.9/class-CakeSession.html

Spec-Zone.ru

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