class Session implements CollectionInterface (View source)

Constants

CORE_SESSION_KEY

The internal session variable

Methods

static Session
configure(array $config)

Configure session instance

static Session|null
getInstance()

Get session singleton

bool
start()

Session starter.

regenerate()

Generate session

bool
has(string|int $key, bool $strict = false)

Allows checking for the existence of a key in the session collection

bool
exists(string $key)

Allows checking for the existence of a key in the session collection

bool
isEmpty()

Check whether a collection is empty.

mixed
get(mixed $key, mixed $default = null)

Retrieves a value or value collection.

mixed
add(string|int $key, mixed $value, bool $next = false)

Add an entry to the collection

mixed
put(string|int $key, mixed $value, $next = false)

The add alias

array
all()

Returns the list of session variables

mixed
remove(string|int $key)

Delete an entry in the collection

mixed
set(string $key, mixed $value)

set

mixed
flash(string|int $key, string|null $message = null)

Add flash data After the data recovery is automatic deleted

array
toArray()

Returns the list of session data as a array.

void
clearFash()

Empty the flash system.

void
clear()

Allows to clear the cache except csrf and __bow.flash

void
flush()

Allows you to empty the session

array
toObject()

Returns the list of session data as a toObject.

string
__toString()

__toString

Details

static Session configure(array $config)

Configure session instance

Parameters

array $config

Return Value

Session

static Session|null getInstance()

Get session singleton

Return Value

Session|null

bool start()

Session starter.

Return Value

bool

regenerate()

Generate session

bool has(string|int $key, bool $strict = false)

Allows checking for the existence of a key in the session collection

Parameters

string|int $key
bool $strict

Return Value

bool

bool exists(string $key)

Allows checking for the existence of a key in the session collection

Parameters

string $key

Return Value

bool

bool isEmpty()

Check whether a collection is empty.

Return Value

bool

mixed get(mixed $key, mixed $default = null)

Retrieves a value or value collection.

Parameters

mixed $key
mixed $default

Return Value

mixed

mixed add(string|int $key, mixed $value, bool $next = false)

Add an entry to the collection

Parameters

string|int $key
mixed $value
bool $next

Return Value

mixed

Exceptions

InvalidArgumentException

mixed put(string|int $key, mixed $value, $next = false)

The add alias

Parameters

string|int $key
mixed $value
$next

Return Value

mixed

See also

Session::add

array all()

Returns the list of session variables

Return Value

array

mixed remove(string|int $key)

Delete an entry in the collection

Parameters

string|int $key

Return Value

mixed

mixed set(string $key, mixed $value)

set

Parameters

string $key
mixed $value

Return Value

mixed

mixed flash(string|int $key, string|null $message = null)

Add flash data After the data recovery is automatic deleted

Parameters

string|int $key
string|null $message

Return Value

mixed

array toArray()

Returns the list of session data as a array.

Return Value

array

void clearFash()

Empty the flash system.

Return Value

void

void clear()

Allows to clear the cache except csrf and __bow.flash

Return Value

void

void flush()

Allows you to empty the session

Return Value

void

array toObject()

Returns the list of session data as a toObject.

Return Value

array

string __toString()

__toString

Return Value

string