interface FlashBagInterface

FlashBagInterface.

@author Drak <drak@zikula.org>

Hierarchy

Expanded class hierarchy of FlashBagInterface

All classes that implement FlashBagInterface

2 files declare their use of FlashBagInterface
FlashBagTest.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Tests/Session/Flash/FlashBagTest.php
Session.php in drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Session/Session.php

File

drupal/core/vendor/symfony/http-foundation/Symfony/Component/HttpFoundation/Session/Flash/FlashBagInterface.php, line 21

Namespace

Symfony\Component\HttpFoundation\Session\Flash
View source
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 $message
   */
  public function set($type, $message);

  /**
   * Gets flash message for a given type.
   *
   * @param string $type    Message category type.
   * @param array  $default Default value if $type doee not exist.
   *
   * @return string
   */
  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 doee not exist.
   *
   * @return string
   */
  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 boolean
   */
  public function has($type);

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

}

Members

Namesort descending 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 message 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