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.
arrayA component lookup table used to lazy load component objects.
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault configuration
\Cake\Controller\ComponentRegistryComponent registry class used to lazy load components.
arrayOther Components this component uses.
Returns an array that can be used to describe the internal state of this object.
Merge provided config with existing config. Unlike config() which does a recursive merge for nested keys, this method does a simple merge.
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
__call(string $name, array $args)
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().
Cake\Http\Exception\InternalErrorException__construct(\Cake\Controller\ComponentRegistry $registry, array $config)
Constructor
\Cake\Controller\ComponentRegistry $registry A component registry this component can use to lazy load its components.
array $config optional Array of configuration settings.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array__get(string $name)
Magic method for lazy loading $components.
string $name Name of component to get.
\Cake\Controller\Component|nullA Component object or null.
_configDelete(string $key)
Deletes a single config key.
string $key Key to delete.
Cake\Core\Exception\Exception_configRead(?string $key)
Reads a config key.
string|null $key Key to read.
mixed_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array $key Key to write to.
mixed $value Value to write.
bool|string $merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\ExceptionconfigShallow(mixed $key, mixed $value)
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']);
string|array $key The key to set, or a complete array of configs.
mixed|null $value optional The value to set.
$thiserror(string $message, array $options = [])
Set a message using "error" element
string $message array $options = [] getConfig(?string $key, mixed $default)
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.
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
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.
mixedConfiguration data at the named key
InvalidArgumentExceptiongetController()
Get the controller this component is bound to.
\Cake\Controller\ControllerThe bound controller.
getSession()
Returns current session object from a controller request.
\Cake\Http\SessionimplementedEvents()
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.
arrayinitialize(array $config)
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
array $config The configuration settings provided to this component.
log(string $message, mixed $level, mixed $context)
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
string $message Log message.
int|string $level optional Error level.
string|array $context optional Additional log data relevant to this message.
boolSuccess of log write.
set(mixed $message, array $options)
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 contentstring|\Throwable $message Message to be flashed. If an instance of \Throwable the throwable message will be used and code will be set in params.
array $options optional An array of options
setConfig(mixed $key, mixed $value, mixed $merge)
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']);
string|array $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\Exceptionsuccess(string $message, array $options = [])
Set a message using "success" element
string $message array $options = [] A component lookup table used to lazy load component objects.
arrayRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault configuration
arrayComponent 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.1/class-Cake.Controller.Component.FlashComponent.html