Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nextcloud/3rdparty.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'symfony/http-foundation/Session/Flash/FlashBagInterface.php')
-rw-r--r--symfony/http-foundation/Session/Flash/FlashBagInterface.php88
1 files changed, 88 insertions, 0 deletions
diff --git a/symfony/http-foundation/Session/Flash/FlashBagInterface.php b/symfony/http-foundation/Session/Flash/FlashBagInterface.php
new file mode 100644
index 00000000..8713e71d
--- /dev/null
+++ b/symfony/http-foundation/Session/Flash/FlashBagInterface.php
@@ -0,0 +1,88 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Session\SessionBagInterface;
+
+/**
+ * FlashBagInterface.
+ *
+ * @author Drak <drak@zikula.org>
+ */
+interface FlashBagInterface extends SessionBagInterface
+{
+ /**
+ * Adds a flash message for the given type.
+ *
+ * @param mixed $message
+ */
+ public function add(string $type, $message);
+
+ /**
+ * Registers one or more messages for a given type.
+ *
+ * @param string|array $messages
+ */
+ public function set(string $type, $messages);
+
+ /**
+ * Gets flash messages for a given type.
+ *
+ * @param string $type Message category type
+ * @param array $default Default value if $type does not exist
+ *
+ * @return array
+ */
+ public function peek(string $type, array $default = []);
+
+ /**
+ * Gets all flash messages.
+ *
+ * @return array
+ */
+ public function peekAll();
+
+ /**
+ * Gets and clears flash from the stack.
+ *
+ * @param array $default Default value if $type does not exist
+ *
+ * @return array
+ */
+ public function get(string $type, array $default = []);
+
+ /**
+ * 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?
+ *
+ * @return bool
+ */
+ public function has(string $type);
+
+ /**
+ * Returns a list of all defined types.
+ *
+ * @return array
+ */
+ public function keys();
+}