cakephp-1.3 > SessionComponent :: setFlash()
A AclBase AclBehavior AclComponent AclNode AclShell Aco AcoAction AjaxHelper ApcEngine ApiShell App AppController AppController AppHelper AppHelper AppModel AppModel Aro AuthComponent B BakeShell BakeTask BehaviorCollection C Cache CacheEngine CacheHelper CakeErrorController CakeLog CakeRoute CakeSchema CakeSession CakeSocket ClassRegistry Component Configure ConnectionManager ConsoleShell ContainableBehavior Controller ControllerTask CookieComponent D DataSource DbAcl DbAclSchema DbConfigTask DboMssql DboMysql DboMysqlBase DboMysqli DboOracle DboPostgres DboSource DboSqlite Debugger Dispatcher E EmailComponent ErrorHandler ErrorHandler ExtractTask F File FileEngine FileLog FixtureTask Folder FormHelper H Helper HtmlHelper HttpSocket I I18n I18nModel i18nSchema I18nShell Inflector IniAcl J JavascriptHelper JqueryEngineHelper JsBaseEngineHelper JsHelper L L10n M MagicDb MagicFileResource MediaView MemcacheEngine Model ModelBehavior ModelTask MootoolsEngineHelper Multibyte N NumberHelper O Object Overloadable Overloadable Overloadable2 Overloadable2 P PagesController PagesController PaginatorHelper Permission PluginShortRoute PluginTask ProjectTask PrototypeEngineHelper R RequestHandlerComponent Router RssHelper S Sanitize Scaffold ScaffoldView SchemaShell Security SecurityComponent SessionComponent SessionHelper SessionsSchema Set Shell ShellDispatcher String T TemplateTask TestSuiteShell TestTask TextHelper ThemeView TimeHelper TranslateBehavior TreeBehavior V Validation View ViewTask X XcacheEngine Xml XmlElement XmlHelper XmlManager XmlNode XmlTextNode

setFlash

line:210 at /cake/libs/controller/components/session.php
Used to set a session variable that can be used to output messages in the view.

Method

setFlash ($message, $element = 'default', $params = array(), $key = 'flash')

Parameters

ParameterTypeCommentDefault
$message string required Message to be flashed
$element string optional Element to wrap flash message in. 'default'
$params array optional Parameters to be sent to layout as view variables array()
$key string optional Message key, default is 'flash' 'flash'

Return

Comment

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

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

Additional params below can be passed to customize the output, or the Message.[key]

@param string $message Message to be flashed
@param string $element Element to wrap flash message in.
@param array $params Parameters to be sent to layout as view variables
@param string $key Message key, default is 'flash'
@access public
@link http://book.cakephp.org/view/1313/setFlash