Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. AutoExpireFlashBag.php

class AutoExpireFlashBag

AutoExpireFlashBag flash message container.

@author Drak <drak@zikula.org>

Hierarchy

  • class \Symfony\Component\HttpFoundation\Session\Flash\AutoExpireFlashBag implements \Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface

Expanded class hierarchy of AutoExpireFlashBag

File

vendor/symfony/http-foundation/Session/Flash/AutoExpireFlashBag.php, line 19

Namespace

Symfony\Component\HttpFoundation\Session\Flash
View source
class AutoExpireFlashBag implements FlashBagInterface {
    private string $name = 'flashes';
    private array $flashes = [
        'display' => [],
        'new' => [],
    ];
    
    /**
     * @param string $storageKey The key used to store flashes in the session
     */
    public function __construct(string $storageKey = '_symfony_flashes') {
    }
    public function getName() : string {
        return $this->name;
    }
    public function setName(string $name) : void {
        $this->name = $name;
    }
    public function initialize(array &$flashes) : void {
        $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'] : [];
        $this->flashes['new'] = [];
    }
    public function add(string $type, mixed $message) : void {
        $this->flashes['new'][$type][] = $message;
    }
    public function peek(string $type, array $default = []) : array {
        return $this->has($type) ? $this->flashes['display'][$type] : $default;
    }
    public function peekAll() : array {
        return \array_key_exists('display', $this->flashes) ? $this->flashes['display'] : [];
    }
    public function get(string $type, array $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;
    }
    public function all() : array {
        $return = $this->flashes['display'];
        $this->flashes['display'] = [];
        return $return;
    }
    public function setAll(array $messages) : void {
        $this->flashes['new'] = $messages;
    }
    public function set(string $type, string|array $messages) : void {
        $this->flashes['new'][$type] = (array) $messages;
    }
    public function has(string $type) : bool {
        return \array_key_exists($type, $this->flashes['display']) && $this->flashes['display'][$type];
    }
    public function keys() : array {
        return array_keys($this->flashes['display']);
    }
    public function getStorageKey() : string {
        return $this->storageKey;
    }
    public function clear() : mixed {
        return $this->all();
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title
AutoExpireFlashBag::$flashes private property
AutoExpireFlashBag::$name private property
AutoExpireFlashBag::add public function Adds a flash message for the given type. Overrides FlashBagInterface::add
AutoExpireFlashBag::all public function Gets and clears flashes from the stack. Overrides FlashBagInterface::all
AutoExpireFlashBag::clear public function Clears out data from bag. Overrides SessionBagInterface::clear
AutoExpireFlashBag::get public function Gets and clears flash from the stack. Overrides FlashBagInterface::get
AutoExpireFlashBag::getName public function Gets this bag&#039;s name. Overrides SessionBagInterface::getName
AutoExpireFlashBag::getStorageKey public function Gets the storage key for this bag. Overrides SessionBagInterface::getStorageKey
AutoExpireFlashBag::has public function Has flash messages for a given type? Overrides FlashBagInterface::has
AutoExpireFlashBag::initialize public function Initializes the Bag. Overrides SessionBagInterface::initialize
AutoExpireFlashBag::keys public function Returns a list of all defined types. Overrides FlashBagInterface::keys
AutoExpireFlashBag::peek public function Gets flash messages for a given type. Overrides FlashBagInterface::peek
AutoExpireFlashBag::peekAll public function Gets all flash messages. Overrides FlashBagInterface::peekAll
AutoExpireFlashBag::set public function Registers one or more messages for a given type. Overrides FlashBagInterface::set
AutoExpireFlashBag::setAll public function Sets all flash messages. Overrides FlashBagInterface::setAll
AutoExpireFlashBag::setName public function
AutoExpireFlashBag::__construct public function

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal