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.

Namespace: Cake\View\Helper

Property Summary

$_View protected

Cake\View\View

The View instance this helper is attached to
$_config protected

array

Runtime config
$_configInitialized protected

bool

Whether the config property has already been configured with defaults
$_defaultConfig protected

array

Default config for this helper.
$_helperMap protected

array

A helper lookup table used to lazy load helper objects.
$fieldset public deprecated

array

Unused.
$helpers protected

array

List of helpers used by this helper
$tags public deprecated

array

Unused.

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.
__set() public

Magic setter for removed properties.
_cleanConfirmMessage() protected

Returns a string read to be used in confirm()
_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
config() public deprecated

Gets/Sets the config.
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.
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

__call() ¶ public

__call(string $method, array $params): void

Provide 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(): array

Returns an array that can be used to describe the internal state of this object.

Returns

array

__get() ¶ public

__get(string $name): Cake\View\Helper|null

Lazy loads helpers.

Parameters

string $name: Name of the property being accessed.

Returns

Cake\View\Helper|null

__set() ¶ public

__set(string $name, mixed $value): void

Magic setter for removed properties.

Parameters

string $name: Property name.
mixed $value: Value to set.

Returns

void

_cleanConfirmMessage() ¶ protected

_cleanConfirmMessage(string $message): mixed

Returns a string read to be used in confirm()

Parameters

string $message: The message to clean

Returns

mixed

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configRead() ¶ protected

_configRead(string|null $key): mixed

Reads a config key.

Parameters

string|null $key: Key to read.

Returns

mixed

_configWrite() ¶ protected

_configWrite(string|array $key, mixed $value, bool|string $merge = false): void

Writes a config key.

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

void

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_confirm() ¶ protected

_confirm(string $message, string $okCode, string $cancelCode = '', array $options = []): string

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

string

addClass() ¶ public

addClass(array $options = [], string|null $class = null, string $key = 'class'): array

Adds the given class to the element options

Parameters

array $options optional: Array options/attributes to add a class to
string|null $class optional: The class name being added.
string $key optional: the key to use for class.

Returns

array

config() ¶ public

config(string|array|null $key = null, mixed|null $value = null, bool $merge = true): mixed

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']);

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

mixed

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallow() ¶ public

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']);

Parameters

string|array $key: The key to set, or a complete array of configs.
mixed|null $value optional: The value to set.

Returns

$this

getConfig() ¶ public

getConfig(string|null $key = null, mixed $default = null): mixed

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: The key to get or null for the whole config.
mixed $default optional: The return value when the key does not exist.

Returns

mixed

getView() ¶ public

getView(): Cake\View\View

Get the view instance this helper is bound to.

Returns

Cake\View\View

implementedEvents() ¶ public

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.

Returns

array

initialize() ¶ public

initialize(array $config): void

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.

Returns

void

render() ¶ public

render(string $key = 'flash', array $options = []): 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.

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|null

Throws

UnexpectedValueException
If value for flash settings key is not an array.

setConfig() ¶ public

setConfig(string|array $key, mixed|null $value = null, bool $merge = true): $this

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: The value to set.
bool $merge optional: Whether to recursively merge or overwrite existing config, defaults to true.

Returns

$this

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

Unused.

Type

array

Namespaces

Class FlashHelper

Property Summary

Method Summary

__call() public

__construct() public

__debugInfo() public

__get() public

__set() public

_cleanConfirmMessage() protected

_configDelete() protected

_configRead() protected

_configWrite() protected

_confirm() protected

addClass() public

config() public deprecated

configShallow() public

getConfig() public

getView() public

implementedEvents() public

initialize() public

render() public

setConfig() public

Method Detail

__call() ¶ public

Parameters

Returns

__construct() ¶ public

Parameters

__debugInfo() ¶ public

Returns

__get() ¶ public

Parameters

Returns

__set() ¶ public

Parameters

Returns

_cleanConfirmMessage() ¶ protected

Parameters

Returns

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

_confirm() ¶ protected

Parameters

Returns

addClass() ¶ public

Parameters

Returns

config() ¶ public

Usage

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

getConfig() ¶ public

Usage

Parameters

Returns

getView() ¶ public

Returns

implementedEvents() ¶ public

Returns

initialize() ¶ public

Parameters

Returns

render() ¶ public

Parameters

Returns

Throws

`$_View` ¶ protected

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_helperMap` ¶ protected

`$fieldset` ¶ public deprecated

`$helpers` ¶ protected

`$tags` ¶ public deprecated