MockFileSessionStorage
extends MockArraySessionStorage
in package
MockFileSessionStorage is used to mock sessions for functional testing when done in a single PHP process.
No PHP session is actually started since a session can be initialized and shutdown only once per PHP execution cycle and this class does not pollute any session related globals, including session_() functions or session. PHP ini directives.
Tags
Table of Contents
- $bags : array<string|int, mixed>|array<string|int, SessionBagInterface>
- $closed : bool
- $data : array<string|int, mixed>
- $id : string
- $metadataBag : MetadataBag
- $name : string
- $started : bool
- $savePath : mixed
- __construct() : mixed
- clear() : mixed
- Clear all session data in memory.
- getBag() : SessionBagInterface
- Gets a SessionBagInterface by name.
- getId() : string
- Returns the session ID.
- getMetadataBag() : MetadataBag
- Gets the MetadataBag.
- getName() : mixed
- Returns the session name.
- isStarted() : bool
- Checks if the session is started.
- regenerate() : bool
- Regenerates id that represents this storage.
- registerBag() : mixed
- Registers a SessionBagInterface for use.
- save() : mixed
- Force the session to be saved and closed.
- setId() : mixed
- Sets the session ID.
- setMetadataBag() : mixed
- setName() : mixed
- Sets the session name.
- setSessionData() : mixed
- start() : bool
- Starts the session.
- generateId() : string
- Generates a session ID.
- loadSession() : mixed
- destroy() : void
- Deletes a session from persistent storage.
- getFilePath() : string
- Calculate path to file.
- read() : void
- Reads session from storage and loads session.
Properties
$bags
protected
array<string|int, mixed>|array<string|int, SessionBagInterface>
$bags
= []
$closed
protected
bool
$closed
= false
$data
protected
array<string|int, mixed>
$data
= []
$id
protected
string
$id
= ''
$metadataBag
protected
MetadataBag
$metadataBag
$name
protected
string
$name
$started
protected
bool
$started
= false
$savePath
private
mixed
$savePath
Methods
__construct()
public
__construct([string $savePath = null ][, string $name = 'MOCKSESSID' ][, MetadataBag $metaBag = null ]) : mixed
Parameters
- $savePath : string = null
-
Path of directory to save session files
- $name : string = 'MOCKSESSID'
-
Session name
- $metaBag : MetadataBag = null
Return values
mixed —clear()
Clear all session data in memory.
public
clear() : mixed
Return values
mixed —getBag()
Gets a SessionBagInterface by name.
public
getBag(mixed $name) : SessionBagInterface
Parameters
- $name : mixed
Return values
SessionBagInterface —getId()
Returns the session ID.
public
getId() : string
Return values
string —The session ID or empty
getMetadataBag()
Gets the MetadataBag.
public
getMetadataBag() : MetadataBag
Return values
MetadataBag —getName()
Returns the session name.
public
getName() : mixed
Return values
mixed —The session name
isStarted()
Checks if the session is started.
public
isStarted() : bool
Return values
bool —True if started, false otherwise
regenerate()
Regenerates id that represents this storage.
public
regenerate([mixed $destroy = false ][, mixed $lifetime = null ]) : bool
Parameters
- $destroy : mixed = false
-
Destroy session when regenerating?
- $lifetime : mixed = null
-
Sets the cookie lifetime for the session cookie. A null value will leave the system settings unchanged, 0 sets the cookie to expire with browser session. Time is in seconds, and is not a Unix timestamp.
Return values
bool —True if session regenerated, false if error
registerBag()
Registers a SessionBagInterface for use.
public
registerBag(SessionBagInterface $bag) : mixed
Parameters
- $bag : SessionBagInterface
Return values
mixed —save()
Force the session to be saved and closed.
public
save() : mixed
Return values
mixed —setId()
Sets the session ID.
public
setId(mixed $id) : mixed
Parameters
- $id : mixed
Return values
mixed —setMetadataBag()
public
setMetadataBag([MetadataBag $bag = null ]) : mixed
Parameters
- $bag : MetadataBag = null
Return values
mixed —setName()
Sets the session name.
public
setName(mixed $name) : mixed
Parameters
- $name : mixed
Return values
mixed —setSessionData()
public
setSessionData(array<string|int, mixed> $array) : mixed
Parameters
- $array : array<string|int, mixed>
Return values
mixed —start()
Starts the session.
public
start() : bool
Return values
bool —True if started
generateId()
Generates a session ID.
protected
generateId() : string
This doesn't need to be particularly cryptographically secure since this is just a mock.
Return values
string —loadSession()
protected
loadSession() : mixed
Return values
mixed —destroy()
Deletes a session from persistent storage.
private
destroy() : void
Deliberately leaves session data in memory intact.
Return values
void —getFilePath()
Calculate path to file.
private
getFilePath() : string
Return values
string —read()
Reads session from storage and loads session.
private
read() : void