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
arrayRuntime config
-
$_configInitialized protected
boolWhether the config property has already been configured with defaults
-
$_defaultConfig protected
arrayDefault config for this helper.
-
$_helperMap protected
arrayA helper lookup table used to lazy load helper objects.
-
$fieldset public
arrayHolds the fields ['field_name' => ['type' => 'string', 'length' => 100]], primaryKey and validates ['field_name']
-
$helpers public
arrayList of helpers used by this helper
-
$plugin public
stringPlugin path
-
$request public
Cake\Network\RequestRequest object
-
$tags public
arrayHolds tag templates.
-
$theme public
stringThe current theme name if any.
Method Summary
-
__call() public
Provide non fatal errors on missing method calls.
-
__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
Delete a single config key
-
_configRead() protected
Read a config variable
-
_configWrite() protected
Write a config variable
-
_confirm() protected
Returns a string to be used as onclick handler for confirm dialogs.
-
addClass() public
Adds the given class to the element options
-
config() public
Usage
-
configShallow() public
Merge provided config with existing config. Unlike
config()which does a recursive merge for nested keys, this method does a simple merge. -
implementedEvents() public
Event listeners.
-
render() public
Used to render the message set in FlashComponent::set()
Method Detail
__call() ¶ public
__call(string $method, array $params): voidProvide non fatal errors on missing method calls.
Parameters
-
string$method Method to invoke
-
array$params Array of params for the method.
Returns
void__construct() ¶ public
__construct(Cake\View\View $View, array $config = [])Default Constructor
Parameters
-
Cake\View\View$View The View this helper is being attached to.
-
array$config optional Configuration settings for the helper.
__debugInfo() ¶ public
__debugInfo(): arrayReturns an array that can be used to describe the internal state of this object.
Returns
array__get() ¶ public
__get(string $name): Cake\View\Helper|voidLazy loads helpers.
Parameters
-
string$name Name of the property being accessed.
Returns
Cake\View\Helper|voidHelper instance if helper with provided name exists
_configDelete() ¶ protected
_configDelete(string $key): voidDelete a single config key
Parameters
-
string$key Key to delete.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_configRead() ¶ protected
_configRead(string|null $key): mixedRead a config variable
Parameters
-
string|null$key Key to read.
Returns
mixed_configWrite() ¶ protected
_configWrite(string|array $key, mixed $value, bool|string $merge = false): voidWrite a config variable
Parameters
-
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.
Returns
voidThrows
Cake\Core\Exception\Exceptionif attempting to clobber existing config
_confirm() ¶ protected
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): stringReturns a string to be used as onclick handler for confirm dialogs.
Parameters
-
string$message Message to be displayed
-
string$okCode Code to be executed after user chose 'OK'
-
string$cancelCode optional Code to be executed after user chose 'Cancel'
-
array$options optional Array of options
Returns
stringonclick JS code
addClass() ¶ public
addClass(array $options = [], string $class = null, string $key = 'class'): arrayAdds the given class to the element options
Parameters
-
array$options optional Array options/attributes to add a class to
-
string$class optional The class name being added.
-
string$key optional the key to use for class.
Returns
arrayArray of options with $key set.
config() ¶ public
config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixedUsage
Reading the whole config:
$this->config();Reading a specific value:
$this->config('key');Reading a nested value:
$this->config('some.nested.key');Setting a specific value:
$this->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array|null$key optional The key to get/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
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\ExceptionWhen trying to set a key that is invalid.
configShallow() ¶ public
configShallow(string|array $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->config('key', $value);Setting a nested value:
$this->config('some.nested.key', $value);Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);Parameters
-
string|array$key The key to set, or a complete array of configs.
-
mixed|null$value optional The value to set.
Returns
$thisThe object itself.
implementedEvents() ¶ public
implementedEvents(): arrayEvent 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
arrayrender() ¶ public
render(string $key = 'flash', array $options = []): string|voidUsed to render the message set in FlashComponent::set()
In your view: $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',
]);Parameters
-
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.
Returns
string|voidRendered flash message or null if flash key does not exist in session.
Throws
UnexpectedValueExceptionIf value for flash settings key is not an array.