FlashBag flash message container.
@author Drak <drak@zikula.org>
Expanded class hierarchy of FlashBag
class FlashBag implements FlashBagInterface, \IteratorAggregate, \Countable {
private $name = 'flashes';
/**
* Flash messages.
*
* @var array
*/
private $flashes = array();
/**
* The storage key for flashes in the session
*
* @var string
*/
private $storageKey;
/**
* Constructor.
*
* @param string $storageKey The key used to store flashes in the session.
*/
public function __construct($storageKey = '_sf2_flashes') {
$this->storageKey = $storageKey;
}
/**
* {@inheritdoc}
*/
public function getName() {
return $this->name;
}
public function setName($name) {
$this->name = $name;
}
/**
* {@inheritdoc}
*/
public function initialize(array &$flashes) {
$this->flashes =& $flashes;
}
/**
* {@inheritdoc}
*/
public function add($type, $message) {
$this->flashes[$type][] = $message;
}
/**
* {@inheritdoc}
*/
public function peek($type, array $default = array()) {
return $this
->has($type) ? $this->flashes[$type] : $default;
}
/**
* {@inheritdoc}
*/
public function peekAll() {
return $this->flashes;
}
/**
* {@inheritdoc}
*/
public function get($type, array $default = array()) {
if (!$this
->has($type)) {
return $default;
}
$return = $this->flashes[$type];
unset($this->flashes[$type]);
return $return;
}
/**
* {@inheritdoc}
*/
public function all() {
$return = $this
->peekAll();
$this->flashes = array();
return $return;
}
/**
* {@inheritdoc}
*/
public function set($type, $messages) {
$this->flashes[$type] = (array) $messages;
}
/**
* {@inheritdoc}
*/
public function setAll(array $messages) {
$this->flashes = $messages;
}
/**
* {@inheritdoc}
*/
public function has($type) {
return array_key_exists($type, $this->flashes) && $this->flashes[$type];
}
/**
* {@inheritdoc}
*/
public function keys() {
return array_keys($this->flashes);
}
/**
* {@inheritdoc}
*/
public function getStorageKey() {
return $this->storageKey;
}
/**
* {@inheritdoc}
*/
public function clear() {
return $this
->all();
}
/**
* Returns an iterator for flashes.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator() {
return new \ArrayIterator($this
->all());
}
/**
* Returns the number of flashes.
*
* @return int The number of flashes
*/
public function count() {
return count($this->flashes);
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
FlashBag:: |
private | property | Flash messages. | |
FlashBag:: |
private | property | ||
FlashBag:: |
private | property | The storage key for flashes in the session | |
FlashBag:: |
public | function |
Adds a flash message for type. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Gets and clears flashes from the stack. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Clears out data from bag. Overrides SessionBagInterface:: |
|
FlashBag:: |
public | function | Returns the number of flashes. | |
FlashBag:: |
public | function |
Gets and clears flash from the stack. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function | Returns an iterator for flashes. | |
FlashBag:: |
public | function |
Gets this bag's name Overrides SessionBagInterface:: |
|
FlashBag:: |
public | function |
Gets the storage key for this bag. Overrides SessionBagInterface:: |
|
FlashBag:: |
public | function |
Has flash messages for a given type? Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Initializes the Bag Overrides SessionBagInterface:: |
|
FlashBag:: |
public | function |
Returns a list of all defined types. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Gets flash message for a given type. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Gets all flash messages. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Registers a message for a given type. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function |
Sets all flash messages. Overrides FlashBagInterface:: |
|
FlashBag:: |
public | function | ||
FlashBag:: |
public | function | Constructor. |