/CakePHP 2.8

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.

Extended by Component
Extended by FlashComponent
Package: Cake\Controller\Component
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Controller/Component/FlashComponent.php

Properties summary

Inherited Properties

Method Summary

  • __call() public
    Magic method for verbose flash methods based on element names.
  • __construct() public
  • set() public
    Used to set a session variable that can be used to output messages in the view.

Method Detail

__call()source public

__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 app/View/Element/Flash for rendering the flash message.


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


If missing the flash message.

__construct()source public

__construct( ComponentCollection $collection , array $settings array() )



ComponentCollection $collection
The ComponentCollection object
array $settings optional array()
Settings passed via controller



set()source public

set( string $message , array $options array() )

Used to set a session variable that can be used to output messages in the view.

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


  • 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


string $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 optional array()
An array of options.

Methods inherited from Component

__get()source public

__get( string $name )

Magic method for lazy loading $components.


string $name
Name of component to get.


A Component object or null.

beforeRedirect()source public

beforeRedirect( Controller $controller , string|array $url , integer $status null , boolean $exit true )

Called before Controller::redirect(). Allows you to replace the URL that will be redirected to with a new URL. The return of this method can either be an array or a string.

If the return is an array and contains a 'url' key. You may also supply the following:

  • status The status code for the redirect
  • exit Whether or not the redirect should exit.

If your response is a string or an array that does not contain a 'url' key it will be used as the new URL to redirect to.


Controller $controller
Controller with components to beforeRedirect
string|array $url
Either the string or URL array that is being redirected to.
integer $status optional null
The status code of the redirect
boolean $exit optional true
Will the script exit.


Either an array or null.



beforeRender()source public

beforeRender( Controller $controller )

Called before the Controller::beforeRender(), and before the view class is loaded, and before Controller::render()


Controller $controller
Controller with components to beforeRender



initialize()source public

initialize( Controller $controller )

Called before the Controller::beforeFilter().


Controller $controller
Controller with components to initialize



shutdown()source public

shutdown( Controller $controller )

Called after Controller::render() and before the output is printed to the browser.


Controller $controller
Controller with components to shutdown



startup()source public

startup( Controller $controller )

Called after the Controller::beforeFilter() and before the controller action


Controller $controller
Controller with components to startup



Methods inherited from Object

_mergeVars()source protected

_mergeVars( array $properties , string $class , boolean $normalize true )

Merges this objects $property with the property in $class' definition. This classes value for the property will be merged on top of $class'

This provides some of the DRY magic CakePHP provides. If you want to shut it off, redefine this method as an empty function.


array $properties
The name of the properties to merge.
string $class
The class to merge the property with.
boolean $normalize optional true
Set to true to run the properties through Hash::normalize() before merging.

_set()source protected

_set( array $properties array() )

Allows setting of multiple properties of the object in a single line of code. Will only set properties that are part of a class declaration.


array $properties optional array()
An associative array containing properties and corresponding values.

_stop()source protected

_stop( integer|string $status 0 )

Stop execution of the current script. Wraps exit() making testing easier.


integer|string $status optional 0
see http://php.net/exit for values

dispatchMethod()source public

dispatchMethod( string $method , array $params array() )

Calls a method on this object with the given parameters. Provides an OO wrapper for call_user_func_array


string $method
Name of the method to call
array $params optional array()
Parameter list to use when calling $method


Returns the result of the method call

log()source public

log( string $msg , integer $type LOG_ERR , null|string|array $scope null )

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


string $msg
Log message
integer $type optional LOG_ERR
Error type constant. Defined in app/Config/core.php.
null|string|array $scope optional null

The scope(s) a log message is being created in. See CakeLog::config() for more information on logging scopes.


Success of log write

requestAction()source public

requestAction( string|array $url , array $extra array() )

Calls a controller's method from any location. Can be used to connect controllers together or tie plugins into a main application. requestAction can be used to return rendered views or fetch the return value from controller actions.

Under the hood this method uses Router::reverse() to convert the $url parameter into a string URL. You should use URL formats that are compatible with Router::reverse()

Passing POST and GET data

POST and GET data can be simulated in requestAction. Use $extra['url'] for GET data. The $extra['data'] parameter allows POST data simulation.


string|array $url

String or array-based URL. Unlike other URL arrays in CakePHP, this URL will not automatically handle passed and named arguments in the $url parameter.

array $extra optional array()

if array includes the key "return" it sets the AutoRender to true. Can also be used to submit GET/POST data, and named/passed arguments.



Boolean true or false on success/failure, or contents of rendered action if 'return' is set in $extra.

toString()source public

toString( )

Object-to-string conversion. Each class can override this method as necessary.


The name of this class

Properties detail


protected array

Default configuration

    'key' => 'flash',
    'element' => 'default',
    'params' => array(),

© 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.