Класс Session

__construct()source public

__construct( array $config [] )

Конструктор.

Конфигурация:

• timeout: Время в минутах, в течение которого сессия должна быть действительной.
• cookiePath: Путь URL, для которого устанавливается cookie сессии. Соответствует конфигурации session.cookie_path в php.ini. По умолчанию - базовый путь приложения.
• ini: Список директив php.ini, которые должны быть изменены перед началом сессии.
• handler: Массив, содержащий, как минимум, ключ class. Используется в качестве движка сессии для сохранения данных. Остальные ключи в массиве будут переданы в качестве конфигурационного массива для движка. Вы можете установить ключ class в уже созданный экземпляр обработчика сессий.

Параметры

array $config optional []

Конфигурация, применяемая к этому объекту сессии

_defaultConfig()source protected static

_defaultConfig( string $name )

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

Параметры

string $name

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

Возвращает

boolean|array

_hasSession()source protected

_hasSession( )

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

Возвращает

boolean

_overwrite()source protected

_overwrite( array $old , array $new )

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

Параметры

array $old

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

array $new

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

_timedOut()source protected

_timedOut( )

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

Возвращает

boolean

check()source public

check( string|null $name null )

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

Параметры

string|null $name optional null

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

Возвращает

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

clear()source public

clear( boolean $renew false )

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

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

Параметры

boolean $renew optional false

Обновлять ли сессию? По умолчанию false.

consume()source public

consume( string $name )

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

Параметры

string $name

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

Возвращает

mixed

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

create()source public static

create( array $sessionConfig [] )

Возвращает новую сессию после построения набора конфигурации для неё. Эта функция позволяет использовать массив опций, которые будут использованы для настройки сессии и обработчика. Самый важный ключ в массиве конфигурации — defaults, который указывает на набор конфигураций для наследования, возможные значения по умолчанию:

• php: просто используйте сессию, как настроено в php.ini
• cache: Используйте систему кэширования CakePHP в качестве хранилища сессии, вам нужно будет передать ключ config с именем уже настроенного движка кэша.
• database: Используйте CakePHP ORM для сохранения и управления сессиями. По умолчанию это требует таблицы в вашей базе данных с именем sessions или ключа model в конфигурации для указания объекта Table, который нужно использовать.
• cake: Используйте файлы для хранения сессий, но позвольте CakePHP управлять ими и решить, где их хранить.

Полный список опций:

• defaults: либо 'php', 'database', 'cache' или 'cake', как описано выше.
• handler: Массив, содержащий конфигурацию обработчика
• ini: Список директив php.ini, которые нужно установить перед запуском сессии.
• timeout: Время в минутах, в течение которого сессия должна оставаться активной

Параметры

массив $sessionConfig необязательно []

Конфигурация сессии.

Возвращает

Cake\Network\Session

См. также

\Cake\Network\Session::__construct()

delete()source public

delete( string $name )

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

Параметры

строка $name

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

destroy()source public

destroy( )

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

engine()source public

engine( string|SessionHandlerInterface|null $class null , array $options [] )

Устанавливает экземпляр обработчика сессии, который будет использоваться для этой сессии. Если для первого аргумента передаётся строка, она будет обрабатываться как имя класса, а второй аргумент будет передан в качестве первого аргумента в конструкторе.

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

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

Параметры

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

Обработчик сессии для использования

массив $options необязательно []

опции, передаваемые в конструктор SessionHandler

Возвращает

SessionHandlerInterface|null

Вызывает

InvalidArgumentException

id()source public

id( string|null $id null )

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

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

Параметры

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

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

Возвращает

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

options()source public

options( array $options )

Вызывает ini_set для каждого ключа в $options и устанавливает их на соответствующее значение в переданном массиве.

Пример:

$session->options(['session.use_cookies' => 1]);

Параметры

массив $options

Опции ini для установки.

Вызывает

RuntimeException
если какая-либо директива не может быть установлена

read()source public

read( string|null $name null )

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

Параметры

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

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

Возвращает

строка|массив|null

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

renew()source public

renew( )

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

start()source public

start( )

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

Возвращает

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

Вызывает

RuntimeException
если сессия уже запущена

started()source public

started( )

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

Возвращает

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

write()source public

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

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

Параметры

строка|массив $name

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

смешанное $value необязательно null

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

false