Задать имя cookie сессии SessionInterface::setName

Модуль: main — подключать отдельно не нужно

Метод SessionInterface::setName задает имя сессии, то есть имя cookie с идентификатором. Вызывайте метод до start. Имя по умолчанию задает параметр session.name в php.ini, поэтому прикладному коду метод нужен редко.

Сигнатура метода в интерфейсе Bitrix\Main\Session\SessionInterface:

public function setName($name);

Параметры

Обязательные параметры обозначены *

Параметр Тип Описание
name* string Задает имя сессии

Тип в таблице описывает назначение аргумента. Сигнатура PHP не объявляет его.

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

Метод ничего не возвращает.

Исключения

Исключение Когда возникает
\RuntimeException Класс Session, сессия PHP уже активна
Bitrix\Main\NotSupportedException Класс KernelSession не поддерживает метод

Примеры

Пример. Код пытается сменить имя запущенной сессии:

<?php
use Bitrix\Main\Application;

require $_SERVER['DOCUMENT_ROOT'] . '/bitrix/modules/main/include/prolog_before.php';

try
{
    Application::getInstance()->getSession()->setName('UNITS_SESSID');
}
catch (\RuntimeException $e)
{
    echo $e->getMessage();
}

Код выведет Could not change the name of an active session.

Смотрите также