\Anax\SessionSessionInterface

Interface for classes wrapping sessions.

Summary

Methods
Constants
name()
start()
has()
get()
getOnce()
set()
delete()
destroy()
No constants found
No protected methods found
N/A
No private methods found
N/A

Methods

name()

name(string  $name) : self

Set a session name.

Parameters

string $name

to set as session name.

Returns

self

start()

start() : self

Start the session (ignore when on cli).

Returns

self

has()

has(string  $key) : boolean

Check if a value is set in the session.

Parameters

string $key

in session variable.

Returns

boolean —

true if $key is set, else false.

get()

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

Get a value from the session.

Parameters

string $key

in session variable.

mixed $default

default value to return when key is not set in the session.

Returns

mixed —

value from session and null if not set.

getOnce()

getOnce(string  $key, mixed  $default = null) : mixed

Read a value from the session and unset it, this is a form of read once flash memory using the session.

Parameters

string $key

in session variable.

mixed $default

default value to return when key is not set in the session.

Returns

mixed —

value from session and null if not set.

set()

set(string  $key, mixed  $value) : self

Set values in session.

Parameters

string $key

in session variable.

mixed $value

to set in session.

Returns

self

delete()

delete(string  $key) : self

Unset session value of this key.

Parameters

string $key

in session variable.

Returns

self

destroy()

destroy() : void

Destroy the session.