StateStorageInterface
in
StateStorageInterface is an interface for Auth client state storage.
Herein 'state' means a named variable, which is persistent between different requests.
Note: in order to function correctly state storage should vary depending on application session, e.g. different web users should not share state with the same name.
Tags
Table of Contents
Methods
- get() : mixed
- Returns the state variable value with the variable name.
- remove() : bool
- Removes a state variable.
- set() : mixed
- Adds a state variable.
Methods
get()
Returns the state variable value with the variable name.
public
get(string $key) : mixed
Parameters
- $key : string
-
the variable name
Return values
mixed —the variable value, or null if the variable does not exist.
remove()
Removes a state variable.
public
remove(string $key) : bool
Parameters
- $key : string
-
the name of the variable to be removed
Return values
bool —success.
set()
Adds a state variable.
public
set(string $key, mixed $value) : mixed
If the specified name already exists, the old value will be overwritten.
Parameters
- $key : string
-
variable name
- $value : mixed
-
variable value