$fieldset
$fieldset : array
Unused.
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.
$_View : \Cake\View\View
The View instance this helper is attached to
__construct(\Cake\View\View $View, array $config = array())
Default Constructor
| \Cake\View\View | $View | The View this helper is being attached to. |
| array | $config | Configuration settings for the helper. |
__get(string $name) : \Cake\View\Helper|null
Lazy loads helpers.
| string | $name | Name of the property being accessed. |
Helper instance if helper with provided name exists
getView() : \Cake\View\View
Get the view instance this helper is bound to.
The bound view instance.
addClass(array $options = array(), string|null $class = null, string $key = 'class') : array
Adds the given class to the element options
| array | $options | Array options/attributes to add a class to |
| string|null | $class | The class name being added. |
| string | $key | the key to use for class. |
Array of options with $key set.
implementedEvents() : array
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.
setConfig(string|array $key, mixed|null $value = null, boolean $merge = true) : $this
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 | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
getConfig(string|null $key = null, mixed $default = null) : mixed
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 | The key to get or null for the whole config. |
| mixed | $default | The return value when the key does not exist. |
Config value being read.
config(string|array|null $key = null, mixed|null $value = null, boolean $merge = true) : mixed
Gets/Sets the config.
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']);| string|array|null | $key | The key to get/set, or a complete array of configs. |
| mixed|null | $value | The value to set. |
| boolean | $merge | Whether to recursively merge or overwrite existing config, defaults to true. |
When trying to set a key that is invalid.
Config value being read, or the object itself on write operations.
configShallow(string|array $key, mixed|null $value = null) : $this
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 | The value to set. |
render(string $key = 'flash', array $options = array()) : string|null
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 | The [Flash.]key you are rendering in the view. |
| array | $options | Additional options to use for the creation of this flash message. Supports the 'params', and 'element' keys that are used in the helper. |
If value for flash settings key is not an array.
Rendered flash message or null if flash key does not exist in session.
_confirm(string $message, string $okCode, string $cancelCode = '', array $options = array()) : string
Returns a string to be used as onclick handler for confirm dialogs.
| string | $message | Message to be displayed |
| string | $okCode | Code to be executed after user chose 'OK' |
| string | $cancelCode | Code to be executed after user chose 'Cancel' |
| array | $options | Array of options |
onclick JS code
_configWrite(string|array $key, mixed $value, boolean|string $merge = false) : void
Writes a config key.
| string|array | $key | Key to write to. |
| mixed | $value | Value to write. |
| boolean|string | $merge | True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false. |
if attempting to clobber existing config