MockFileSessionStorage

class MockFileSessionStorage extends MockArraySessionStorage

MockFileSessionStorage используется для имитации сессий при функциональном тестировании в одном процессе PHP.

PHP сессия фактически не запускается, так как сессия может быть инициализирована и завершена только один раз в цикле выполнения PHP, и этот класс не загрязняет глобальные переменные, связанные с сессиями, включая функции session_*() или директивы PHP ini session.*.

Методы

	__construct(string $savePath = null, string $name = 'MOCKSESSID', MetadataBag $metaBag = null)
	setSessionData(array $array) Устанавливает данные сессии.	из MockArraySessionStorage
bool	start() Запускает сессию.
bool	regenerate(bool $destroy = false, int $lifetime = null) Пересоздаёт идентификатор, представляющий это хранилище.
string	getId() Возвращает идентификатор сессии.	из MockArraySessionStorage
	setId(string $id) Устанавливает идентификатор сессии.	из MockArraySessionStorage
mixed	getName() Возвращает имя сессии.	из MockArraySessionStorage
	setName(string $name) Устанавливает имя сессии.	из MockArraySessionStorage
	save() Принудительно сохраняет и закрывает сессию.
	clear() Очищает все данные сессии в памяти.	из MockArraySessionStorage
	registerBag(SessionBagInterface $bag) Регистрирует SessionBagInterface для использования.	из MockArraySessionStorage
SessionBagInterface	getBag(string $name) Получает SessionBagInterface по имени.	из MockArraySessionStorage
bool	isStarted() Проверяет, запущена ли сессия.	из MockArraySessionStorage
	setMetadataBag(MetadataBag $bag = null) Устанавливает MetadataBag.	из MockArraySessionStorage
MetadataBag	getMetadataBag() Получает MetadataBag.	из MockArraySessionStorage

Детали

__construct(string $savePath = null, string $name = 'MOCKSESSID', MetadataBag $metaBag = null)

Параметры

string	$savePath	Путь к каталогу для сохранения файлов сессии
string	$name	Имя сессии
MetadataBag	$metaBag	Экземпляр MetadataBag

setSessionData(array $array)

Устанавливает данные сессии.

Параметры

array

$array

bool start()

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

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

bool	True, если запущено

Исключения

RuntimeException

если возникла ошибка при запуске сессии

bool regenerate(bool $destroy = false, int $lifetime = null)

Перегенерирует идентификатор, представляющий это хранилище.

Этот метод должен вызывать sessionregenerateid($destroy), если этот интерфейс не используется для объекта хранилища, предназначенного для тестирования на единицах или функциональных тестах, где реальная сессия PHP повлияет на тестирование.

Примечание: regenerate+destroy не должно очищать данные сессии в памяти, а только удалять данные сессии из постоянного хранилища.

Внимание: При перегенерации идентификатора сессии в разработке PHP сессии блокировка не используется. См. https://bugs.php.net/bug.php?id=61470 для обсуждения. Таким образом, необходимо убедиться, что сгенерированная сессия сохранена ДО отправки заголовков с новым идентификатором. Symfony's HttpKernel предлагает слушатель для этого. См. Symfony\Component\HttpKernel\EventListener\SaveSessionListener. В противном случае данные сессии могут снова быть потеряны для одновременных запросов с новым идентификатором. Одним из результатов может быть выход из системы после только входа в систему.

Параметры

bool	$destroy	Уничтожить сессию при перегенерации?
int	$lifetime	Устанавливает срок действия cookie сессии. Значение null оставит настройки системы без изменений, 0 установит cookie так, чтобы он истекал вместе с сессией браузера. Время указано в секундах и не является меткой времени Unix.

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

bool	True, если сессия перегенерирована, false в случае ошибки

Исключения

RuntimeException

Если при перегенерации этого хранилища произошла ошибка

string getId()

Возвращает идентификатор сессии.

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

string

Идентификатор сессии или пустая строка

setId(string $id)

Устанавливает идентификатор сессии.

Параметры

string

$id

mixed getName()

Возвращает имя сессии.

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

mixed

Имя сессии

setName(string $name)

Устанавливает имя сессии.

Параметры

string

$name

save()

Принудительно сохраняет и закрывает сессию.

Этот метод должен вызывать sessionwriteclose(), если этот интерфейс используется для объекта хранилища, предназначенного для тестирования на единицах или функциональных тестах, где реальная сессия PHP повлияет на тестирование, в этом случае он должен фактически сохранять данные сессии, если это необходимо.