Library
Class

Library\Session\FlashSession

class FlashSession extends Session

Session manager class

Constants

SESSION_NAME

The session attributes application stack

SESSION_ATTRIBUTESNAME

The session attributes stack

SESSION_FLASHESNAME

The session flash messages stack

Methods

__construct()

Constructor

__destruct()

Automatically store new entries at object destruction

from Session
Session addSessionTable(string $index, mixed $value)

Add a session table entry

from Session
array getSessionTable()

Get the full session table

from Session
string getId()

Get current session ID

from Session
string getName()

Get current session name

from Session
bool isOpened()

Test if the current session is already started

from Session
bool isLoaded()

Test if the current session is already loaded

from Session
Session start()

Start the current session and read it

from Session
Session open()

Open the current session

from Session
Session close()

Close the current session

from Session
FlashSession read()

Start the current session if so

FlashSession commit()

Save current session

Session clear()

Destroy current session

from Session
Session regenerateId()

Regenrate current session ID

from Session
array getAttributes()

Get all current session values

from Session
bool has(string $param)

Test if the current session has a parameter

from Session
mixed get(string $param)

Get current session parameter

from Session
Session set(string $param, mixed $value)

Set current session parameter

from Session
Session remove(string $param)

Delete a session parameter

from Session
Session getBackup(string $param)

Get an initial session value

from Session
bool hasFlash()

Test if current session has flash parameters

mixed getFlash(string $index)

Get a current session flash parameter

FlashSession setFlash(mixed $value, string $index = null)

Set a current session flash parameter

array allFlashes()

Get current session flash parameters stack

FlashSession clearFlashes()

Delete current session flash parameters

Details

at line 55
public __construct()

Constructor

in Session at line 87
public __destruct()

Automatically store new entries at object destruction

in Session at line 105
public Session addSessionTable(string $index, mixed $value)

Add a session table entry

Parameters

string $index
mixed $value

Return Value

Session

in Session at line 116
public array getSessionTable()

Get the full session table

Return Value

array

in Session at line 126
public string getId()

Get current session ID

Return Value

string

in Session at line 139
public string getName()

Get current session name

Return Value

string

in Session at line 149
public bool isOpened()

Test if the current session is already started

Return Value

bool

in Session at line 159
public bool isLoaded()

Test if the current session is already loaded

Return Value

bool

in Session at line 173
public Session start()

Start the current session and read it

Return Value

Session

in Session at line 189
public Session open()

Open the current session

Return Value

Session

in Session at line 207
public Session close()

Close the current session

Return Value

Session

at line 67
public FlashSession read()

Start the current session if so

Return Value

FlashSession

at line 85
public FlashSession commit()

Save current session

Return Value

FlashSession

in Session at line 258
public Session clear()

Destroy current session

Return Value

Session

in Session at line 273
public Session regenerateId()

Regenrate current session ID

Return Value

Session

in Session at line 287
public array getAttributes()

Get all current session values

Return Value

array

in Session at line 301
public bool has(string $param)

Test if the current session has a parameter

Parameters

string $param

Return Value

bool

in Session at line 315
public mixed get(string $param)

Get current session parameter

Parameters

string $param

Return Value

mixed

in Session at line 330
public Session set(string $param, mixed $value)

Set current session parameter

Parameters

string $param
mixed $value

Return Value

Session

in Session at line 345
public Session remove(string $param)

Delete a session parameter

Parameters

string $param

Return Value

Session

in Session at line 362
public Session getBackup(string $param)

Get an initial session value

Parameters

string $param

Return Value

Session

at line 98
public bool hasFlash()

Test if current session has flash parameters

Return Value

bool

at line 112
public mixed getFlash(string $index)

Get a current session flash parameter

Parameters

string $index

Return Value

mixed

at line 133
public FlashSession setFlash(mixed $value, string $index = null)

Set a current session flash parameter

Parameters

mixed $value
string $index

Return Value

FlashSession

at line 151
public array allFlashes()

Get current session flash parameters stack

Return Value

array

at line 169
public FlashSession clearFlashes()

Delete current session flash parameters

Return Value

FlashSession