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