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.
__call( string $name , array $args )
Magic method for verbose flash methods based on element names.
For example: $this->Flash->success('My message') would use the success.ctp element under src/Template/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.ctp element under plugins/PluginName/src/Template/Element/Flash
for rendering the flash message.
$name
$args
FlashComponent::set()
.Cake\Network\Exception\InternalErrorException
__construct( Cake\Controller\ComponentRegistry $registry , array $config [] )
Constructor
Cake\Controller\ComponentRegistry
$registry
$config
optional [] Cake\Controller\Component::__construct()
set( string|Exception $message , array $options [] )
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');
key
The key to set under the session's Flash keyelement
The element used to render the flash message. Default to 'default'.params
An array of variables to make available when using an elementclear
A bool stating if the current stack should be cleared to start a new one$message
$options
optional [] __debugInfo( )
Returns an array that can be used to describe the internal state of this object.
array
__get( string $name )
Magic method for lazy loading $components.
$name
mixed
implementedEvents( )
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.
array
Cake\Event\EventListenerInterface::implementedEvents()
initialize( array $config )
Constructor hook method.
Implement this method to avoid having to overwrite the constructor and call parent.
$config
_configDelete( string $key )
Delete a single config key
$key
Cake\Core\Exception\Exception
_configRead( string|null $key )
Read a config variable
$key
mixed
_configWrite( string|array $key , mixed $value , boolean|string $merge false )
Write a config variable
$key
$value
$merge
optional false Cake\Core\Exception\Exception
config( string|array|null $key null , mixed|null $value null , boolean $merge true )
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']);
$key
optional null $value
optional null $merge
optional true mixed
Cake\Core\Exception\Exception
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->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']);
$key
$value
optional null mixed
log( mixed $msg , integer|string $level LogLevel::ERROR , string|array $context [] )
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
$msg
$level
optional LogLevel::ERROR $context
optional [] boolean
protected array
A component lookup table used to lazy load component objects.
[]
protected Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
protected boolean
Whether the config property has already been configured with defaults
false
© 2005–2016 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
http://api.cakephp.org/3.1/class-Cake.Controller.Component.FlashComponent.html