1. class
  2. WPEmerge
  3. \
  4. Flash
  5. \
  6. Flash

Flash

class Flash (View source)

Provide a way to flash data into the session for the next request.

Constants

CURRENT_KEY

Keys for different request contexts.
NEXT_KEY

Methods

__construct(array|ArrayAccess $store, string $store_key = '__wpemergeFlash')

Constructor.

array|ArrayAccess
getStore()

Get the store for flash messages.

void
setStore(array|ArrayAccess $store)

Set the store for flash messages.

boolean
enabled()

Get whether the flash service is enabled.

void
add(string $key, mixed $new_items)

Add values for a key for the next request.

void
addNow(string $key, mixed $new_items)

Add values for a key for the current request.

mixed
get(string|null $key = null, mixed $default = [])

Get the entire store or the values for a key for the current request.

mixed
getNext(string|null $key = null, mixed $default = [])

Get the entire store or the values for a key for the next request.

void
clear(string|null $key = null)

Clear the entire store or the values for a key for the current request.

void
clearNext(string|null $key = null)

Clear the entire store or the values for a key for the next request.

void
shift()

Shift current store and replace it with next store.

void
save()

Save flashed data to store.

Details

at line 55
__construct(array|ArrayAccess $store, string $store_key = '__wpemergeFlash')

Constructor.

Parameters

array|ArrayAccess $store
string $store_key

at line 89
array|ArrayAccess getStore()

Get the store for flash messages.

Return Value

array|ArrayAccess

at line 99
void setStore(array|ArrayAccess $store)

Set the store for flash messages.

Parameters

array|ArrayAccess $store

Return Value

void

at line 121
boolean enabled()

Get whether the flash service is enabled.

Return Value

boolean

at line 182
void add(string $key, mixed $new_items)

Add values for a key for the next request.

Parameters

string $key
mixed $new_items

Return Value

void

at line 193
void addNow(string $key, mixed $new_items)

Add values for a key for the current request.

Parameters

string $key
mixed $new_items

Return Value

void

at line 204
mixed get(string|null $key = null, mixed $default = [])

Get the entire store or the values for a key for the current request.

Parameters

string|null $key
mixed $default

Return Value

mixed

at line 215
mixed getNext(string|null $key = null, mixed $default = [])

Get the entire store or the values for a key for the next request.

Parameters

string|null $key
mixed $default

Return Value

mixed

at line 225
void clear(string|null $key = null)

Clear the entire store or the values for a key for the current request.

Parameters

string|null $key

Return Value

void

at line 235
void clearNext(string|null $key = null)

Clear the entire store or the values for a key for the next request.

Parameters

string|null $key

Return Value

void

at line 244
void shift()

Shift current store and replace it with next store.

Return Value

void

at line 256
void save()

Save flashed data to store.

Return Value

void