Class FlashMessage
The FlashMessage class provides a way for you to write a flash variable to the session, to be rendered in a view with the FlashHelper.
Property Summary
-
$_config protected
array<string, mixed>Runtime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
array<string, mixed>Default configuration
-
$session protected
Cake\Http\Session
Method Summary
-
__construct() public
Constructor
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
consume() public
Get the messages for given key and remove from session.
-
error() public
Set an success message.
-
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
info() public
Set an info message.
-
set() public
Store flash messages that can be output in the view.
-
setConfig() public
Sets the config.
-
setExceptionMessage() public
Set an exception's message as flash message.
-
success() public
Set a success message.
-
warning() public
Set a warning message.
Method Detail
__construct() ¶ public
__construct(Cake\Http\Session $session, array<string, mixed> $config = [])Constructor
Parameters
-
Cake\Http\Session$session Session instance.
-
array<string, mixed>$config optional Config array.
See Also
_configDelete() ¶ protected
_configDelete(string $key): voidDeletes a single config key.
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedReads a config key.
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): voidWrites a config key.
Parameters
-
array<string, mixed>|string$key Key to write to.
-
mixed$value Value to write.
-
string|bool$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Returns
voidThrows
Cake\Core\Exception\CakeExceptionif attempting to clobber existing config
configShallow() ¶ public
configShallow(array<string, mixed>|string $key, mixed|null $value = null): $thisMerge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);Setting a nested value:
$this->configShallow('some.nested.key', $value);Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisconsume() ¶ public
consume(string $key): array|nullGet the messages for given key and remove from session.
Parameters
-
string$key The key for get messages for.
Returns
array|nullerror() ¶ public
error(string $message, array<string, mixed> $options = []): voidSet an success message.
The 'element' option will be set to 'error'.
Parameters
-
string$message Message to flash.
-
array<string, mixed>$options optional An array of options.
Returns
voidSee Also
getConfig() ¶ public
getConfig(string|null $key = null, mixed $default = null): mixedReturns the config.
Usage
Reading the whole config:
$this->getConfig();Reading a specific value:
$this->getConfig('key');Reading a nested value:
$this->getConfig('some.nested.key');Reading with default value:
$this->getConfig('some-key', 'default-value');Parameters
-
string|null$key optional The key to get or null for the whole config.
-
mixed$default optional The return value when the key does not exist.
Returns
mixedgetConfigOrFail() ¶ public
getConfigOrFail(string $key): mixedReturns the config for this specific key.
The config value for this key must exist, it can never be null.
Parameters
-
string$key The key to get.
Returns
mixedThrows
InvalidArgumentExceptioninfo() ¶ public
info(string $message, array<string, mixed> $options = []): voidSet an info message.
The 'element' option will be set to 'info'.
Parameters
-
string$message Message to flash.
-
array<string, mixed>$options optional An array of options.
Returns
voidSee Also
set() ¶ public
set(string $message, array<string, mixed> $options = []): voidStore flash messages that can be output in the view.
If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)
Options:
keyThe key to set under the session's Flash key.elementThe element used to render the flash message. You can use'SomePlugin.name'style value for flash elements from a plugin.pluginPlugin name to use element from.paramsAn array of variables to be made available to the element.clearA bool stating if the current stack should be cleared to start a new one.escapeSet to false to allow templates to print out HTML content.
Parameters
-
string$message Message to be flashed.
-
array<string, mixed>$options optional An array of options
Returns
voidSee Also
setConfig() ¶ public
setConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $thisSets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);Setting a nested value:
$this->setConfig('some.nested.key', $value);Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);Parameters
-
array<string, mixed>|string$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
-
bool$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$thisThrows
Cake\Core\Exception\CakeExceptionWhen trying to set a key that is invalid.
setExceptionMessage() ¶ public
setExceptionMessage(Throwable $exception, array<string, mixed> $options = []): voidSet an exception's message as flash message.
The following options will be set by default if unset:
'element' => 'error',
`params' => ['code' => $exception->getCode()]Parameters
-
Throwable$exception Exception instance.
-
array<string, mixed>$options optional An array of options.
Returns
voidSee Also
success() ¶ public
success(string $message, array<string, mixed> $options = []): voidSet a success message.
The 'element' option will be set to 'success'.
Parameters
-
string$message Message to flash.
-
array<string, mixed>$options optional An array of options.
Returns
voidSee Also
warning() ¶ public
warning(string $message, array<string, mixed> $options = []): voidSet a warning message.
The 'element' option will be set to 'warning'.
Parameters
-
string$message Message to flash.
-
array<string, mixed>$options optional An array of options.
Returns
voidSee Also
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool