php/yii2
1
0
Fork 0
mirror of https://github.com/yiisoft/yii2.git synced 2025-11-23 01:57:50 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation to mention addFlash

Browse Source
This commit is contained in:
nkovacs
2014-09-30 09:51:17 +02:00
parent 88dabc49c2
commit f41abf9105
1 changed files with 10 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
framework/web/Session.php
View File

@@ -625,8 +625,9 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* @param mixed $defaultValue value to be returned if the flash message does not exist. * @param mixed $defaultValue value to be returned if the flash message does not exist.
* @param boolean $delete whether to delete this flash message right after this method is called. * @param boolean $delete whether to delete this flash message right after this method is called.
* If false, the flash message will be automatically deleted in the next request. * If false, the flash message will be automatically deleted in the next request.
* @return mixed the flash message * @return mixed the flash message or an array of messages if addFlash was used
* @see setFlash() * @see setFlash()
* @see addFlash()
* @see hasFlash() * @see hasFlash()
* @see getAllFlashes() * @see getAllFlashes()
* @see removeFlash() * @see removeFlash()
@@ -665,12 +666,15 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* With the above code you can use the [bootstrap alert][] classes such as `success`, `info`, `danger` * With the above code you can use the [bootstrap alert][] classes such as `success`, `info`, `danger`
* as the flash message key to influence the color of the div. * as the flash message key to influence the color of the div.
* *
* Note that if you use [[addFlash()]], `$message` will be an array, and you will have to adjust the above code.
*
* [bootstrap alert]: http://getbootstrap.com/components/#alerts * [bootstrap alert]: http://getbootstrap.com/components/#alerts
* *
* @param boolean $delete whether to delete the flash messages right after this method is called. * @param boolean $delete whether to delete the flash messages right after this method is called.
* If false, the flash messages will be automatically deleted in the next request. * If false, the flash messages will be automatically deleted in the next request.
* @return array flash messages (key => message). * @return array flash messages (key => message or key => [message1, message2]).
* @see setFlash() * @see setFlash()
* @see addFlash()
* @see getFlash() * @see getFlash()
* @see hasFlash() * @see hasFlash()
* @see removeFlash() * @see removeFlash()
@@ -712,6 +716,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* regardless if it is accessed or not. If true (default value), the flash message will remain until after * regardless if it is accessed or not. If true (default value), the flash message will remain until after
* it is accessed. * it is accessed.
* @see getFlash() * @see getFlash()
* @see addFlash()
* @see removeFlash() * @see removeFlash()
*/ */
public function setFlash($key, $value = true, $removeAfterAccess = true) public function setFlash($key, $value = true, $removeAfterAccess = true)
@@ -732,6 +737,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* regardless if it is accessed or not. If true (default value), the flash message will remain until after * regardless if it is accessed or not. If true (default value), the flash message will remain until after
* it is accessed. * it is accessed.
* @see getFlash() * @see getFlash()
* @see setFlash()
* @see removeFlash() * @see removeFlash()
*/ */
public function addFlash($key, $value = true, $removeAfterAccess = true) public function addFlash($key, $value = true, $removeAfterAccess = true)
@@ -758,6 +764,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* @return mixed the removed flash message. Null if the flash message does not exist. * @return mixed the removed flash message. Null if the flash message does not exist.
* @see getFlash() * @see getFlash()
* @see setFlash() * @see setFlash()
* @see addFlash()
* @see removeAllFlashes() * @see removeAllFlashes()
*/ */
public function removeFlash($key) public function removeFlash($key)
@@ -777,6 +784,7 @@ class Session extends Component implements \IteratorAggregate, \ArrayAccess, \Co
* by this method. * by this method.
* @see getFlash() * @see getFlash()
* @see setFlash() * @see setFlash()
* @see addFlash()
* @see removeFlash() * @see removeFlash()
*/ */
public function removeAllFlashes() public function removeAllFlashes()