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.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default configuration
Cake\Http\SessionConstructor
Deletes a single config key.
Reads a config key.
Writes a config key.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Get the messages for given key and remove from session.
Set an success message.
Returns the config.
Returns the config for this specific key.
Set an info message.
Store flash messages that can be output in the view.
Sets the config.
Set an exception's message as flash message.
Set a success message.
Set a warning message.
__construct(Cake\Http\Session $session, array<string, mixed> $config = [])
Constructor
Cake\Http\Session $session Session instance.
array<string, mixed> $config optional Config array.
_configDelete(string $key): void
Deletes a single config key.
string $key Key to delete.
voidCake\Core\Exception\CakeException_configRead(string|null $key): mixed
Reads a config key.
string|null $key Key to read.
mixed_configWrite(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void
Writes a config key.
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.
voidCake\Core\Exception\CakeExceptionconfigShallow(array<string, mixed>|string $key, mixed|null $value = null): $this
Merge 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']);
array<string, mixed>|string $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thisconsume(string $key): array|null
Get the messages for given key and remove from session.
string $key The key for get messages for.
array|nullerror(string $message, array<string, mixed> $options = []): void
Set an success message.
The 'element' option will be set to 'error'.
string $message Message to flash.
array<string, mixed> $options optional An array of options.
voidgetConfig(string|null $key = null, mixed $default = null): mixed
Returns the config.
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'); 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.
mixedgetConfigOrFail(string $key): mixed
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedInvalidArgumentExceptioninfo(string $message, array<string, mixed> $options = []): void
Set an info message.
The 'element' option will be set to 'info'.
string $message Message to flash.
array<string, mixed> $options optional An array of options.
voidset(string $message, array<string, mixed> $options = []): void
Store 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)
key The key to set under the session's Flash key.element The element used to render the flash message. You can use 'SomePlugin.name' style value for flash elements from a plugin.plugin Plugin name to use element from.params An array of variables to be made available to the element.clear A bool stating if the current stack should be cleared to start a new one.escape Set to false to allow templates to print out HTML content.string $message Message to be flashed.
array<string, mixed> $options optional An array of options
voidsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Sets the config.
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']);
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.
$thisCake\Core\Exception\CakeExceptionsetExceptionMessage(Throwable $exception, array<string, mixed> $options = []): void
Set an exception's message as flash message.
The following options will be set by default if unset:
'element' => 'error', `params' => ['code' => $exception->getCode()]
Throwable $exception Exception instance.
array<string, mixed> $options optional An array of options.
voidsuccess(string $message, array<string, mixed> $options = []): void
Set a success message.
The 'element' option will be set to 'success'.
string $message Message to flash.
array<string, mixed> $options optional An array of options.
voidwarning(string $message, array<string, mixed> $options = []): void
Set a warning message.
The 'element' option will be set to 'warning'.
string $message Message to flash.
array<string, mixed> $options optional An array of options.
voidRuntime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault configuration
array<string, mixed>Cake\Http\Session
© 2005–present The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/4.4/class-Cake.Http.FlashMessage.html