$request
$request : \Cake\Http\ServerRequest
Request object
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.
Like Controller and Table, this class has an initialize() hook that you can use to add custom 'constructor' logic. It is important to remember that each request (and sub-request) will only make one instance of any given component.
Components can provide several callbacks that are fired at various stages of the request cycle. The available callbacks are:
beforeFilter(Event $event)
Called before the controller's beforeFilter method by default.startup(Event $event)
Called after the controller's beforeFilter method, and before the
controller action is called.beforeRender(Event $event)
Called before the Controller beforeRender, and before the view class is loaded.shutdown(Event $event)
Called after the action is complete and the view has been rendered but
before Controller::afterFilter().beforeRedirect(Event $event $url, Response $response)
Called before a redirect is done. Allows you to change the URL that will
be redirected to by returning a Response instance with new URL set using
Response::location(). Redirection can be prevented by stopping the event
propagation.While the controller is not an explicit argument for the callback methods it is the subject of each event and can be fetched using Event::getSubject().
$request : \Cake\Http\ServerRequest
Request object
$response : \Cake\Http\Response
Response object
$_registry : \Cake\Controller\ComponentRegistry
Component registry class used to lazy load components.
$_session : \Cake\Http\Session
The Session object instance
__construct(\Cake\Controller\ComponentRegistry $registry, array $config = array())
Constructor
| \Cake\Controller\ComponentRegistry | $registry | A ComponentRegistry for this component |
| array | $config | Array of config. |
getController() : \Cake\Controller\Controller
Get the controller this component is bound to.
The bound controller.
implementedEvents() : array
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.
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. |
log(mixed $msg, integer|string $level = \Psr\Log\LogLevel::ERROR, string|array $context = array()) : boolean
Convenience method to write a message to Log. See Log::write() for more information on writing to logs.
| mixed | $msg | Log message. |
| integer|string | $level | Error level. |
| string|array | $context | Additional log data relevant to this message. |
Success of log write.
set(string|\Exception $message, array $options = array()) : 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');
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 oneescape Set to false to allow templates to print out HTML content| string|\Exception | $message | Message to be flashed. If an instance of \Exception the exception message will be used and code will be set in params. |
| array | $options | An array of options |
__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.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.
| string | $name | Element name to use. |
| array | $args | Parameters to pass when calling |
If missing the flash message.
_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