feature #46491 Introduce FlashBagAwareSessionInterface (VincentLanglet)

fabpot · fabpot · commit 077d4c96cdce · 2022-07-03T16:28:54.000+02:00
This PR was squashed before being merged into the 6.2 branch. Discussion ---------- Introduce FlashBagAwareSessionInterface | Q | A | ------------- | --- | Branch? | 6.2 for features | Bug fix? | no | New feature? | yes | Deprecations? | no | Tickets | Fix #41765 | License | MIT | Doc PR | symfony/symfony-docs#... Not needed This solve #41765 People will be able to write ``` $session = $request->getSession(); if ($session instanceof FlashBagAwareSessionInterface) { $session->addFlashBag(...); } ``` This is better than a `instanceof Session` check (which is not working with decoration). Commits ------- 026c748 Introduce FlashBagAwareSessionInterface
diff --git a/src/Symfony/Component/HttpFoundation/Session/FlashBagAwareSessionInterface.php b/src/Symfony/Component/HttpFoundation/Session/FlashBagAwareSessionInterface.php
@@ -0,0 +1,22 @@
+<?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;
+
+use Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface;
+
+/**
+ * Interface for session with a flashbag.
+ */
+interface FlashBagAwareSessionInterface extends SessionInterface
+{
+    public function getFlashBag(): FlashBagInterface;
+}
diff --git a/src/Symfony/Component/HttpFoundation/Session/Session.php b/src/Symfony/Component/HttpFoundation/Session/Session.php
@@ -30,7 +30,7 @@ class_exists(SessionBagProxy::class);
  *
  * @implements \IteratorAggregate<string, mixed>
  */
-class Session implements SessionInterface, \IteratorAggregate, \Countable
+class Session implements FlashBagAwareSessionInterface, \IteratorAggregate, \Countable
 {
     protected $storage;
 

Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ class_exists(SessionBagProxy::class);`
`30`	`30`	`*`
`31`	`31`	`* @implements \IteratorAggregate<string, mixed>`
`32`	`32`	`*/`
`33`		`-class Session implements SessionInterface, \IteratorAggregate, \Countable`
	`33`	`+class Session implements FlashBagAwareSessionInterface, \IteratorAggregate, \Countable`
`34`	`34`	`{`
`35`	`35`	`protected $storage;`
`36`	`36`