MockArraySessionStorage

class MockArraySessionStorage implements SessionStorageInterface

MockArraySessionStorage имитирует сессию для юнит-тестов.

PHP сессия фактически не запускается, так как сессию можно инициализировать и завершить только один раз за цикл выполнения PHP.

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

Методы

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

Подробности

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

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

Параметры

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