FlashHelper class to render flash messages.
After setting messages in your controllers with FlashComponent, you can use this class to output your flash messages in your views.
\Cake\View\ViewThe View instance this helper is attached to
arrayRuntime config
boolWhether the config property has already been configured with defaults
arrayDefault config for this helper.
arrayA helper lookup table used to lazy load helper objects.
arrayList of helpers used by this helper
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.
__call(string $method, array $params)
Provide non fatal errors on missing method calls.
string $method Method to invoke
array $params Array of params for the method.
mixed|void__construct(\Cake\View\View $view, array $config)
Default Constructor
\Cake\View\View $view The View this helper is being attached to.
array $config optional Configuration settings for the helper.
__debugInfo()
Returns an array that can be used to describe the internal state of this object.
array__get(string $name)
Lazy loads helpers.
string $name Name of the property being accessed.
\Cake\View\Helper|null|voidHelper instance if helper with provided name exists
_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\Exception_confirm(string $okCode, string $cancelCode)
Returns a string to be used as onclick handler for confirm dialogs.
string $okCode Code to be executed after user chose 'OK'
string $cancelCode Code to be executed after user chose 'Cancel'
string"onclick" JS code
addClass(array $options, string $class, string $key)
Adds the given class to the element options
array $options Array options/attributes to add a class to
string $class The class name being added.
string $key optional the key to use for class. Defaults to 'class'.
arrayArray of options with $key set.
configShallow(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.
$thisgetConfig(?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
InvalidArgumentExceptiongetView()
Get the view instance this helper is bound to.
\Cake\View\ViewThe bound view instance.
implementedEvents()
Event listeners.
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 helper.
render(string $key, array $options)
Used to render the message set in FlashComponent::set()
In your template file: $this->Flash->render('somekey'); Will default to flash if no param is passed
You can pass additional information into the flash message generation. This allows you to consolidate all the parameters for a given type of flash message into the view.
echo $this->Flash->render('flash', ['params' => ['name' => $user['User']['name']]]); This would pass the current user's name into the flash message, so you could create personalized messages without the controller needing access to that data.
Lastly you can choose the element that is used for rendering the flash message. Using custom elements allows you to fully customize how flash messages are generated.
echo $this->Flash->render('flash', ['element' => 'my_custom_element']); If you want to use an element from a plugin for rendering your flash message you can use the dot notation for the plugin's element name:
echo $this->Flash->render('flash', [
'element' => 'MyPlugin.my_custom_element',
]); If you have several messages stored in the Session, each message will be rendered in its own element.
string $key optional The [Flash.]key you are rendering in the view.
array $options optional Additional options to use for the creation of this flash message. Supports the 'params', and 'element' keys that are used in the helper.
string|nullRendered flash message or null if flash key does not exist in session.
UnexpectedValueExceptionsetConfig(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\ExceptionThe View instance this helper is attached to
\Cake\View\ViewRuntime config
arrayWhether the config property has already been configured with defaults
boolDefault config for this helper.
arrayA helper lookup table used to lazy load helper objects.
arrayList of helpers used by this helper
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.View.Helper.FlashHelper.html