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.
- Cake\View\Helper implements Cake\Event\EventListenerInterface uses Cake\Core\InstanceConfigTrait
-
Cake\View\Helper\FlashHelper
Inherited Properties
Method Summary
-
implementedEvents() public
Event listeners. -
render() public
Used to render the message set in FlashComponent::set()
Method Detail
render() public ¶
render( string $key 'flash' , 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.
Parameters
- string $key optional 'flash'
- 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
Rendered flash message or null if flash key does not exist in session.
Throws
If value for flash settings key is not an array.
Methods inherited from Cake\View\Helper
__call() public ¶
__call( string $method , array $params )
Provide non fatal errors on missing method calls.
Parameters
- string $method
- Method to invoke
- array $params
- Array of params for the method.
__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( )
Returns an array that can be used to describe the internal state of this object.
Returns
__get() public ¶
__get( string $name )
Lazy loads helpers.
Parameters
- string $name
- Name of the property being accessed.
Returns
__set() public ¶
__set( string $name , mixed $value )
Magic setter for removed properties.
Parameters
- string $name
- Property name.
- mixed $value
- Value to set.
_cleanConfirmMessage() protected ¶
_cleanConfirmMessage( string $message )
Returns a string read to be used in confirm()
Parameters
- string $message
- The message to clean
Returns
_confirm() protected ¶
_confirm( string $message , string $okCode , string $cancelCode '' , array $options [] )
Returns 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
onclick JS code
addClass() public ¶
addClass( array $options [] , string|null $class null , string $key 'class' )
Adds the given class to the element options
Parameters
- array $options optional []
- Array options/attributes to add a class to
- string|null $class optional null
- The class name being added.
- string $key optional 'class'
- the key to use for class.
Returns
Array of options with $key set.
initialize() public ¶
initialize( array $config )
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
Parameters
- array $config
- The configuration settings provided to this helper.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public ¶
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
Gets/Sets the config.
Usage
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']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value null )
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']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key null , mixed $default null )
Returns 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 null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Config value being read.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value null , boolean $merge true )
Sets 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
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this