The CakePHP FlashComponent provides a way for you to write a flash variable to the session from your controllers, to be rendered in a view with the FlashHelper.
array<string, array>A component lookup table used to lazy load component objects.
array<string, mixed>Runtime config
boolWhether the config property has already been configured with defaults
array<string, mixed>Default configuration
Cake\Controller\ComponentRegistryComponent registry class used to lazy load components.
arrayOther Components this component uses.
Magic method for verbose flash methods based on element names.
Constructor
Returns an array that can be used to describe the internal state of this object.
Magic method for lazy loading $components.
Deletes a single config key.
Reads a config key.
Writes a config key.
Proxy method to FlashMessage instance.
Set a message using "error" element
Get flash message utility instance.
Proxy method to FlashMessage instance.
Proxy method to FlashMessage instance.
Get the controller this component is bound to.
Get the Controller callbacks this Component is interested in.
Set a message using "info" element
Constructor hook method.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
Used to set a session variable that can be used to output messages in the view. If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)
Proxy method to FlashMessage instance.
Set a message using "success" element
Set a message using "warning" element
__call(string $name, array $args): void
Magic method for verbose flash methods based on element names.
For example: $this->Flash->success('My message') would use the success.php element under templates/element/flash/ for rendering the flash message.
If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)
Note that the parameter element will be always overridden. In order to call a specific element from a plugin, you should set the plugin option in $args.
For example: $this->Flash->warning('My message', ['plugin' => 'PluginName']) would use the warning.php element under plugins/PluginName/templates/element/flash/ for rendering the flash message.
string $name Element name to use.
array $args Parameters to pass when calling FlashComponent::set().
voidCake\Http\Exception\InternalErrorException__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])
Constructor
Cake\Controller\ComponentRegistry $registry A component registry this component can use to lazy load its components.
array<string, mixed> $config optional Array of configuration settings.
__debugInfo(): array<string, mixed>
Returns an array that can be used to describe the internal state of this object.
array<string, mixed>__get(string $name): Cake\Controller\Component|null
Magic method for lazy loading $components.
string $name Name of component to get.
Cake\Controller\Component|null_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
Proxy method to FlashMessage instance.
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.
$thiserror(string $message, array $options = []): void
Set a message using "error" element
string $message array $options optional voidflash(): Cake\Http\FlashMessage
Get flash message utility instance.
Cake\Http\FlashMessagegetConfig(string|null $key = null, mixed $default = null): mixed
Proxy method to FlashMessage instance.
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
Proxy method to FlashMessage instance.
The config value for this key must exist, it can never be null.
string $key The key to get.
mixedInvalidArgumentExceptiongetController(): Cake\Controller\Controller
Get the controller this component is bound to.
Cake\Controller\ControllerimplementedEvents(): array<string, mixed>
Get the Controller callbacks this Component is interested in.
Uses Conventions to map controller events to standard component callback method names. By defining one of the callback methods a component is assumed to be interested in the related event.
Override this method if you need to add non-conventional event listeners. Or if you want components to listen to non-standard events.
array<string, mixed>info(string $message, array $options = []): void
Set a message using "info" element
string $message array $options optional voidinitialize(array<string, mixed> $config): void
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array<string, mixed> $config The configuration settings provided to this component.
voidlog(string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string $message Log message.
string|int $level optional Error level.
array|string $context optional Additional log data relevant to this message.
boolset(Throwable|string $message, array<string, mixed> $options = []): void
Used to set a session variable that can be used to output messages in the view. If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)
In your controller: $this->Flash->set('This has been saved');
key The key to set under the session's Flash keyelement The element used to render the flash message. Default to 'default'.params An array of variables to make available when using an elementclear A bool stating if the current stack should be cleared to start a new oneescape Set to false to allow templates to print out HTML contentThrowable|string $message Message to be flashed. If an instance of \Throwable the throwable message will be used and code will be set in params.
array<string, mixed> $options optional An array of options
voidsetConfig(array<string, mixed>|string $key, mixed|null $value = null, bool $merge = true): $this
Proxy method to FlashMessage instance.
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\CakeExceptionsuccess(string $message, array $options = []): void
Set a message using "success" element
string $message array $options optional voidwarning(string $message, array $options = []): void
Set a message using "warning" element
string $message array $options optional voidA component lookup table used to lazy load component objects.
array<string, array>Runtime config
array<string, mixed>Whether the config property has already been configured with defaults
boolDefault configuration
These are merged with user-provided config when the component is used.
array<string, mixed>Component registry class used to lazy load components.
Cake\Controller\ComponentRegistryOther Components this component uses.
array
© 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.Controller.Component.FlashComponent.html