Class FlashHelper
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.
Property Summary
-
$_View protected
Cake\View\ViewThe View instance this helper is attached to
-
$_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 config for this helper.
-
$helperInstances protected
array<string, \Cake\View\Helper>Loaded helper instances.
-
$helpers protected
arrayList of helpers used by this helper
Method Summary
-
__construct() public
Default Constructor
-
__debugInfo() public
Returns an array that can be used to describe the internal state of this object.
-
__get() public
Lazy loads helpers.
-
_configDelete() protected
Deletes a single config key.
-
_configRead() protected
Reads a config key.
-
_configWrite() protected
Writes a config key.
-
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs.
-
addClass() public
Adds the given class to the element options
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
getConfig() public
Returns the config.
-
getConfigOrFail() public
Returns the config for this specific key.
-
getView() public
Get the view instance this helper is bound to.
-
implementedEvents() public
Event listeners.
-
initialize() public
Constructor hook method.
-
render() public
Used to render the message set in FlashComponent::set()
-
setConfig() public
Sets the config.
Method Detail
__construct() ¶ public
__construct(Cake\View\View $view, array<string, mixed> $config = [])Default Constructor
Parameters
-
Cake\View\View$view The View this helper is being attached to.
-
array<string, mixed>$config optional Configuration settings for the helper.
__debugInfo() ¶ public
__debugInfo(): array<string, mixed>Returns an array that can be used to describe the internal state of this object.
Returns
array<string, mixed>__get() ¶ public
__get(string $name): Cake\View\Helper|nullLazy loads helpers.
Parameters
-
string$name Name of the property being accessed.
Returns
Cake\View\Helper|nullHelper instance if helper with provided name exists
_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
_confirm() ¶ protected
_confirm(string $okCode, string $cancelCode): stringReturns a string to be used as onclick handler for confirm dialogs.
Parameters
-
string$okCode Code to be executed after user chose 'OK'
-
string$cancelCode Code to be executed after user chose 'Cancel'
Returns
string"onclick" JS code
addClass() ¶ public
addClass(array<string, mixed> $options, string $class, string $key = 'class'): array<string, mixed>Adds the given class to the element options
Parameters
-
array<string, mixed>$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'.
Returns
array<string, mixed>Array of options with $key set.
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
$thisgetConfig() ¶ 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
mixedConfiguration data at the named key or null if the key does not exist.
getConfigOrFail() ¶ 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
mixedConfiguration data at the named key
Throws
InvalidArgumentExceptiongetView() ¶ public
getView(): Cake\View\ViewGet the view instance this helper is bound to.
Returns
Cake\View\ViewThe bound view instance.
implementedEvents() ¶ public
implementedEvents(): array<string, mixed>Event listeners.
By defining one of the callback methods a helper 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 helpers to listen to non-standard events.
Returns
array<string, mixed>initialize() ¶ public
initialize(array<string, mixed> $config): voidConstructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
-
array<string, mixed>$config The configuration settings provided to this helper.
Returns
voidrender() ¶ public
render(string $key = 'flash', array<string, mixed> $options = []): string|nullUsed 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.
Parameters
-
string$key optional The [Flash.]key you are rendering in the view.
-
array<string, mixed>$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.
Returns
string|nullRendered flash message or null if flash key does not exist in session.
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.
Property Detail
$_configInitialized ¶ protected
Whether the config property has already been configured with defaults
Type
bool