MockFileSessionStorage

class MockFileSessionStorage extends MockArraySessionStorage

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

PHP сессия фактически не запускается, так как сессия может быть инициализирована и завершена только один раз за цикл выполнения PHP, и этот класс не загрязняет какие-либо глобальные переменные, связанные с сессиями, включая функции session_*() или директивы ini PHP 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)	из MockArraySessionStorage
MetadataBag	getMetadataBag() Получает MetadataBag.	из MockArraySessionStorage

Подробности

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

Параметры

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

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-сеанс будет мешать тестированию, в противном случае он должен фактически сохранять данные сеанса, если это необходимо.