Classes List

Symfony\Component\HttpFoundation\Session\Flash\AutoExpireFlashBag

 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 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
 107 
 108 
 109 
 110 
 111 
 112 
 113 
 114 
 115 
 116 
 117 
 118 
 119 
 120 
 121 
 122 
 123 
 124 
 125 
 126 
 127 
 128 
 129 
 130 
 131 
 132 
 133 
 134 
 135 
 136 
 137 
 138 
 139 
 140 
 141 
 142 
 143 
 144 
 145 
 146 
 147 
 148 
 149 
 150 
 151 
 152 
 153 
 154 
 155 
 156 
 157 
 158 
 159 
 160 
 161 
 162 
<?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;

/** * AutoExpireFlashBag flash message container. * * @author Drak <drak@zikula.org> */
class AutoExpireFlashBag implements FlashBagInterface
{
    private $name = 'flashes';
    private $flashes = array('display' => array(), 'new' => array());
    private $storageKey;

    /** * @param string $storageKey The key used to store flashes in the session */
    public function __construct($storageKey = '_symfony_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;

        // The logic: messages from the last request will be stored in new, so we move them to previous
        // This request we will show what is in 'display'. What is placed into 'new' this time round will
        // be moved to display next time round.
        $this->flashes['display'] = array_key_exists('new'$this->flashes) ? $this->flashes['new'] : array();
        $this->flashes['new'] = array();
    }

    /** * {@inheritdoc} */
    public function add($type$message)
    {
        $this->flashes['new'][$type][] = $message;
    }

    /** * {@inheritdoc} */
    public function peek($typearray $default = array())
    {
        return $this->has($type) ? $this->flashes['display'][$type] : $default;
    }

    /** * {@inheritdoc} */
    public function peekAll()
    {
        return array_key_exists('display'$this->flashes) ? (array) $this->flashes['display'] : array();
    }

    /** * {@inheritdoc} */
    public function get($typearray $default = array())
    {
        $return = $default;

        if (!$this->has($type)) {
            return $return;
        }

        if (isset($this->flashes['display'][$type])) {
            $return = $this->flashes['display'][$type];
            unset($this->flashes['display'][$type]);
        }

        return $return;
    }

    /** * {@inheritdoc} */
    public function all()
    {
        $return = $this->flashes['display'];
        $this->flashes['display'] = array();

        return $return;
    }

    /** * {@inheritdoc} */
    public function setAll(array $messages)
    {
        $this->flashes['new'] = $messages;
    }

    /** * {@inheritdoc} */
    public function set($type$messages)
    {
        $this->flashes['new'][$type] = (array) $messages;
    }

    /** * {@inheritdoc} */
    public function has($type)
    {
        return array_key_exists($type$this->flashes['display']) && $this->flashes['display'][$type];
    }

    /** * {@inheritdoc} */
    public function keys()
    {
        return array_keys($this->flashes['display']);
    }

    /** * {@inheritdoc} */
    public function getStorageKey()
    {
        return $this->storageKey;
    }

    /** * {@inheritdoc} */
    public function clear()
    {
        return $this->all();
    }
}