Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of the Symfony package.
Chris@0:  *
Chris@0:  * (c) Fabien Potencier <fabien@symfony.com>
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Symfony\Component\HttpFoundation\Session\Flash;
Chris@0: 
Chris@0: /**
Chris@0:  * AutoExpireFlashBag flash message container.
Chris@0:  *
Chris@0:  * @author Drak <drak@zikula.org>
Chris@0:  */
Chris@0: class AutoExpireFlashBag implements FlashBagInterface
Chris@0: {
Chris@0:     private $name = 'flashes';
Chris@17:     private $flashes = ['display' => [], 'new' => []];
Chris@0:     private $storageKey;
Chris@0: 
Chris@0:     /**
Chris@0:      * @param string $storageKey The key used to store flashes in the session
Chris@0:      */
Chris@14:     public function __construct($storageKey = '_symfony_flashes')
Chris@0:     {
Chris@0:         $this->storageKey = $storageKey;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getName()
Chris@0:     {
Chris@0:         return $this->name;
Chris@0:     }
Chris@0: 
Chris@0:     public function setName($name)
Chris@0:     {
Chris@0:         $this->name = $name;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function initialize(array &$flashes)
Chris@0:     {
Chris@0:         $this->flashes = &$flashes;
Chris@0: 
Chris@0:         // The logic: messages from the last request will be stored in new, so we move them to previous
Chris@0:         // This request we will show what is in 'display'.  What is placed into 'new' this time round will
Chris@0:         // be moved to display next time round.
Chris@18:         $this->flashes['display'] = \array_key_exists('new', $this->flashes) ? $this->flashes['new'] : [];
Chris@17:         $this->flashes['new'] = [];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function add($type, $message)
Chris@0:     {
Chris@0:         $this->flashes['new'][$type][] = $message;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     public function peek($type, array $default = [])
Chris@0:     {
Chris@0:         return $this->has($type) ? $this->flashes['display'][$type] : $default;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function peekAll()
Chris@0:     {
Chris@18:         return \array_key_exists('display', $this->flashes) ? (array) $this->flashes['display'] : [];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@17:     public function get($type, array $default = [])
Chris@0:     {
Chris@0:         $return = $default;
Chris@0: 
Chris@0:         if (!$this->has($type)) {
Chris@0:             return $return;
Chris@0:         }
Chris@0: 
Chris@0:         if (isset($this->flashes['display'][$type])) {
Chris@0:             $return = $this->flashes['display'][$type];
Chris@0:             unset($this->flashes['display'][$type]);
Chris@0:         }
Chris@0: 
Chris@0:         return $return;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function all()
Chris@0:     {
Chris@0:         $return = $this->flashes['display'];
Chris@17:         $this->flashes['display'] = [];
Chris@0: 
Chris@0:         return $return;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function setAll(array $messages)
Chris@0:     {
Chris@0:         $this->flashes['new'] = $messages;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function set($type, $messages)
Chris@0:     {
Chris@0:         $this->flashes['new'][$type] = (array) $messages;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function has($type)
Chris@0:     {
Chris@18:         return \array_key_exists($type, $this->flashes['display']) && $this->flashes['display'][$type];
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function keys()
Chris@0:     {
Chris@0:         return array_keys($this->flashes['display']);
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function getStorageKey()
Chris@0:     {
Chris@0:         return $this->storageKey;
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * {@inheritdoc}
Chris@0:      */
Chris@0:     public function clear()
Chris@0:     {
Chris@0:         return $this->all();
Chris@0:     }
Chris@0: }