interface FlashBagInterface in Zircon Profile 8

FlashBagInterface.

@author Drak <[e-mail]>

Hierarchy

• interface \Symfony\Component\HttpFoundation\Session\SessionBagInterface
  • interface \Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface

1 file declares its use of FlashBagInterface

Session.php in vendor/symfony/http-foundation/Session/Session.php

File

vendor/symfony/http-foundation/Session/Flash/FlashBagInterface.php, line 21

Namespace

Symfony\Component\HttpFoundation\Session\Flash

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($type, array $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($type, array $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();

}

Members

Name	Modifiers	Type	Description	Overrides
FlashBagInterface::add	public	function	Adds a flash message for type.	2
FlashBagInterface::all	public	function	Gets and clears flashes from the stack.	2
FlashBagInterface::get	public	function	Gets and clears flash from the stack.	2
FlashBagInterface::has	public	function	Has flash messages for a given type?	2
FlashBagInterface::keys	public	function	Returns a list of all defined types.	2
FlashBagInterface::peek	public	function	Gets flash messages for a given type.	2
FlashBagInterface::peekAll	public	function	Gets all flash messages.	2
FlashBagInterface::set	public	function	Registers a message for a given type.	2
FlashBagInterface::setAll	public	function	Sets all flash messages.	2
SessionBagInterface::clear	public	function	Clears out data from bag.	4
SessionBagInterface::getName	public	function	Gets this bag's name.	4
SessionBagInterface::getStorageKey	public	function	Gets the storage key for this bag.	4
SessionBagInterface::initialize	public	function	Initializes the Bag.	4