Class FlashComponent

The CakePHP FlashComponent provides a way for you to write a flash variable to the session from your controllers, to be rendered in a view with the FlashHelper.

Namespace: Cake\Controller\Component

Property Summary

$_config protected

array<string, mixed>

Runtime config
$_configInitialized protected

bool

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

array<string, mixed>

Default configuration
$_registry protected

Cake\Controller\ComponentRegistry

Component registry class used to lazy load components.
$componentInstances protected

array<string, \Cake\Controller\Component>

Loaded component instances.
$components protected

array

Other Components this component uses.

Method Summary

__call() public

Magic method for verbose flash methods based on element names.
__construct() public

Constructor
__debugInfo() public

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

Magic method for lazy loading $components.
_configDelete() protected

Deletes a single config key.
_configRead() protected

Reads a config key.
_configWrite() protected

Writes a config key.
configShallow() public

Proxy method to FlashMessage instance.
error() public @method

Set a message using "error" element
flash() protected

Get flash message utility instance.
getConfig() public

Proxy method to FlashMessage instance.
getConfigOrFail() public

Proxy method to FlashMessage instance.
getController() public

Get the controller this component is bound to.
implementedEvents() public

Get the Controller callbacks this Component is interested in.
info() public @method

Set a message using "info" element
initialize() public

Constructor hook method.
log() public

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
set() public

Used to set a session variable that can be used to output messages in the view. If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)
setConfig() public

Proxy method to FlashMessage instance.
success() public @method

Set a message using "success" element
warning() public @method

Set a message using "warning" element

Method Detail

__call() ¶ public

__call(string $name, array $args): void

Magic method for verbose flash methods based on element names.

For example: $this->Flash->success('My message') would use the success.php element under templates/element/flash/ for rendering the flash message.

If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)

Note that the parameter element will be always overridden. In order to call a specific element from a plugin, you should set the plugin option in $args.

For example: $this->Flash->warning('My message', ['plugin' => 'PluginName']) would use the warning.php element under plugins/PluginName/templates/element/flash/ for rendering the flash message.

Parameters

string $name: Element name to use.
array $args: Parameters to pass when calling FlashComponent::set().

Returns

void

Throws

Cake\Http\Exception\InternalErrorException
If missing the flash message.

__construct() ¶ public

__construct(Cake\Controller\ComponentRegistry $registry, array<string, mixed> $config = [])

Constructor

Parameters

Cake\Controller\ComponentRegistry $registry: A component registry this component can use to lazy load its components.
array<string, mixed> $config optional: Array of configuration settings.

__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\Controller\Component|null

Magic method for lazy loading $components.

Parameters

string $name: Name of component to get.

Returns

Cake\Controller\Component|null

_configDelete() ¶ protected

_configDelete(string $key): void

Deletes a single config key.

Parameters

string $key: Key to delete.

Returns

void

Throws

Cake\Core\Exception\CakeException
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(array<string, mixed>|string $key, mixed $value, string|bool $merge = false): void

Writes 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

void

Throws

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

configShallow() ¶ public

configShallow(array<string, mixed>|string $key, mixed|null $value = null): $this

Proxy method to FlashMessage instance.

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

$this

error() ¶ public @method

error(string $message, array $options = []): void

Set a message using "error" element

Parameters

string $message
array $options optional

Returns

void

flash() ¶ protected

flash(): Cake\Http\FlashMessage

Get flash message utility instance.

Returns

Cake\Http\FlashMessage

getConfig() ¶ public

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

Proxy method to FlashMessage instance.

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

getConfigOrFail() ¶ public

getConfigOrFail(string $key): mixed

Proxy method to FlashMessage instance.

The config value for this key must exist, it can never be null.

Parameters

string $key: The key to get.

Returns

mixed

Throws

InvalidArgumentException

getController() ¶ public

getController(): Cake\Controller\Controller

Get the controller this component is bound to.

Returns

Cake\Controller\Controller

implementedEvents() ¶ public

implementedEvents(): array<string, mixed>

Get the Controller callbacks this Component is interested in.

Uses Conventions to map controller events to standard component callback method names. By defining one of the callback methods a component 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 components to listen to non-standard events.

Returns

array<string, mixed>

info() ¶ public @method

info(string $message, array $options = []): void

Set a message using "info" element

Parameters

string $message
array $options optional

Returns

void

initialize() ¶ public

initialize(array<string, mixed> $config): void

Constructor 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 component.

Returns

void

log() ¶ public

log(Stringable|string $message, string|int $level = LogLevel::ERROR, array|string $context = []): bool

Convenience method to write a message to Log. See Log::write() for more information on writing to logs.

Parameters

Stringable|string $message: Log message.
string|int $level optional: Error level.
array|string $context optional: Additional log data relevant to this message.

Returns

bool

set() ¶ public

set(Throwable|string $message, array<string, mixed> $options = []): void

Used to set a session variable that can be used to output messages in the view. If you make consecutive calls to this method, the messages will stack (if they are set with the same flash key)

In your controller: $this->Flash->set('This has been saved');

Options:

key The key to set under the session's Flash key
element The element used to render the flash message. Default to 'default'.
params An array of variables to make available when using an element
clear A bool stating if the current stack should be cleared to start a new one
escape Set to false to allow templates to print out HTML content

Parameters

Throwable|string $message: Message to be flashed. If an instance of \Throwable the throwable message will be used and code will be set in params.
array<string, mixed> $options optional: An array of options

Returns

void

setConfig() ¶ public

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

Proxy method to FlashMessage instance.

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

$this

Throws

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

success() ¶ public @method

success(string $message, array $options = []): void

Set a message using "success" element

Parameters

string $message
array $options optional

Returns

void

warning() ¶ public @method

warning(string $message, array $options = []): void

Set a message using "warning" element

Parameters

string $message
array $options optional

Returns

void

Property Detail

`$_config` ¶ protected

Runtime config

Type

array<string, mixed>

`$_configInitialized` ¶ protected

Whether the config property has already been configured with defaults

Type

bool

`$_defaultConfig` ¶ protected

Default configuration

These are merged with user-provided config when the component is used.

Type

array<string, mixed>

`$_registry` ¶ protected

Component registry class used to lazy load components.

Type

Cake\Controller\ComponentRegistry

`$componentInstances` ¶ protected

Loaded component instances.

Type

array<string, \Cake\Controller\Component>

`$components` ¶ protected

Other Components this component uses.

Type

array

Namespaces

Class FlashComponent

Property Summary

Method Summary

__call() public

__construct() public

__debugInfo() public

__get() public

_configDelete() protected

_configRead() protected

_configWrite() protected

configShallow() public

error() public @method

flash() protected

getConfig() public

getConfigOrFail() public

getController() public

implementedEvents() public

info() public @method

initialize() public

log() public

set() public

setConfig() public

success() public @method

warning() public @method

Method Detail

__call() ¶ public

Parameters

Returns

Throws

__construct() ¶ public

Parameters

__debugInfo() ¶ public

Returns

__get() ¶ public

Parameters

Returns

_configDelete() ¶ protected

Parameters

Returns

Throws

_configRead() ¶ protected

Parameters

Returns

_configWrite() ¶ protected

Parameters

Returns

Throws

configShallow() ¶ public

Parameters

Returns

error() ¶ public @method

Parameters

Returns

flash() ¶ protected

Returns

getConfig() ¶ public

Usage

Parameters

Returns

getConfigOrFail() ¶ public

Parameters

Returns

Throws

getController() ¶ public

Returns

implementedEvents() ¶ public

Returns

info() ¶ public @method

Parameters

Returns

initialize() ¶ public

Parameters

Returns

log() ¶ public

Parameters

Returns

set() ¶ public

Options:

Parameters

`$_config` ¶ protected

`$_configInitialized` ¶ protected

`$_defaultConfig` ¶ protected

`$_registry` ¶ protected

`$componentInstances` ¶ protected

`$components` ¶ protected