Classes List

Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\HttpFoundation\Session\Flash;

use Symfony\Component\HttpFoundation\Session\SessionBagInterface;

/** * FlashBagInterface. * * @author Drak <drak@zikula.org> */
interface FlashBagInterface extends SessionBagInterface
{
    /** * Adds a flash message for type. * * @param string $type * @param string $message */
    public function add($type$message);

    /** * Registers a message for a given type. * * @param string $type * @param string|array $message */
    public function set($type$message);

    /** * Gets flash messages for a given type. * * @param string $type Message category type * @param array $default Default value if $type does not exist * * @return array */
    public function peek($typearray $default = array());

    /** * Gets all flash messages. * * @return array */
    public function peekAll();

    /** * Gets and clears flash from the stack. * * @param string $type * @param array $default Default value if $type does not exist * * @return array */
    public function get($typearray $default = array());

    /** * Gets and clears flashes from the stack. * * @return array */
    public function all();

    /** * Sets all flash messages. */
    public function setAll(array $messages);

    /** * Has flash messages for a given type? * * @param string $type * * @return bool */
    public function has($type);

    /** * Returns a list of all defined types. * * @return array */
    public function keys();
}