symfony · jtattevin · Apr 2, 2024 · Aug 23, 2024 · Dec 17, 2024 · lyrixx
diff --git a/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php b/src/Symfony/Bundle/FrameworkBundle/Resources/config/web.php
@@ -23,6 +23,7 @@
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestPayloadValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\RequestValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\ServiceValueResolver;
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionParameterValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\UidValueResolver;
 use Symfony\Component\HttpKernel\Controller\ArgumentResolver\VariadicValueResolver;
@@ -101,6 +102,9 @@
         ->set('argument_resolver.query_parameter_value_resolver', QueryParameterValueResolver::class)
             ->tag('controller.targeted_value_resolver', ['name' => QueryParameterValueResolver::class])
 
+        ->set('argument_resolver.session_parameter_value_resolver', SessionParameterValueResolver::class)
+            ->tag('controller.targeted_value_resolver', ['name' => SessionParameterValueResolver::class])
+
         ->set('response_listener', ResponseListener::class)
             ->args([
                 param('kernel.charset'),

diff --git a/src/Symfony/Bundle/FrameworkBundle/composer.json b/src/Symfony/Bundle/FrameworkBundle/composer.json
@@ -26,7 +26,7 @@
         "symfony/error-handler": "^7.3",
         "symfony/event-dispatcher": "^6.4|^7.0",
         "symfony/http-foundation": "^7.3",
-        "symfony/http-kernel": "^7.2",
+        "symfony/http-kernel": "^7.3",
         "symfony/polyfill-mbstring": "~1.0",
         "symfony/filesystem": "^7.1",
         "symfony/finder": "^6.4|^7.0",

diff --git a/src/Symfony/Component/HttpKernel/Attribute/MapSessionParameter.php b/src/Symfony/Component/HttpKernel/Attribute/MapSessionParameter.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Attribute;
+
+use Symfony\Component\HttpKernel\Controller\ArgumentResolver\SessionParameterValueResolver;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+
+/**
+ * Can be used to pass a session parameter to a controller argument.
+ */
+#[\Attribute(\Attribute::TARGET_PARAMETER)]
+class MapSessionParameter extends ValueResolver
+{
+    /**
+     * @param string|null                                 $name     The name of the session parameter; if null, the name of the argument in the controller will be used
+     * @param class-string<ValueResolverInterface>|string $resolver The name of the resolver to use
+     */
+    public function __construct(
+        public ?string $name = null,
+        string $resolver = SessionParameterValueResolver::class,
+    ) {
+        parent::__construct($resolver);
+    }
+}
diff --git a/src/Symfony/Component/HttpKernel/CHANGELOG.md b/src/Symfony/Component/HttpKernel/CHANGELOG.md
@@ -8,7 +8,8 @@ CHANGELOG
  * Support `Uid` in `#[MapQueryParameter]`
  * Add `ServicesResetterInterface`, implemented by `ServicesResetter`
  * Allow configuring the logging channel per type of exceptions in ErrorListener
-
+ * Add `#[MapSessionParameter]` to pass a session parameter to a controller argument
+
 7.2
 ---
 

diff --git a/...ymfony/Component/HttpKernel/Controller/ArgumentResolver/SessionParameterValueResolver.php b/...ymfony/Component/HttpKernel/Controller/ArgumentResolver/SessionParameterValueResolver.php
@@ -0,0 +1,68 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\HttpKernel\Controller\ArgumentResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpKernel\Attribute\MapSessionParameter;
+use Symfony\Component\HttpKernel\Controller\ValueResolverInterface;
+use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
+
+final class SessionParameterValueResolver implements ValueResolverInterface
+{
+    public function resolve(Request $request, ArgumentMetadata $argument): array
+    {
+        if (!$attribute = $argument->getAttributesOfType(MapSessionParameter::class, ArgumentMetadata::IS_INSTANCEOF)[0] ?? null) {
+            return [];
+        }
+
+        if (!$request->hasSession()) {
+            return [];
+        }
+
+        if ((!$type = $argument->getType()) || (!class_exists($type) && !interface_exists($type, false))) {
+            if ($type && (str_contains($type, '|') || str_contains($type, '&'))) {
+                if (!$argument->hasDefaultValue() && !$argument->isNullable()) {
+                    throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is an union or intersection type, you need to make the parameter nullable or provide a default value..', $argument->getName(), $type));
+                }
+            } else {
+                throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is not a class or interface name.', $argument->getName(), $type));
+            }
+        }
+
+        if (interface_exists($type, false) && !$argument->hasDefaultValue() && !$argument->isNullable()) {
+            throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used on controller argument "$%s": "%s" is an interface, you need to make the parameter nullable or provide a default value.', $argument->getName(), $type));
+        }
+
+        $name = $attribute->name ?? $argument->getName();
+        if ($request->getSession()->has($name)) {
+            $value = $request->getSession()->get($name);
+            if (!$value instanceof $type && !str_contains($type, '|') && !str_contains($type, '&')) {
+                throw new \LogicException(\sprintf('#[MapSessionParameter] cannot be used to map controller argument "$%s": the session contains a value of type "%s" which is not an instance of "%s".', $argument->getName(), get_debug_type($value), $type));
+            }
+
+            return [$value];
+        }
+
+        if ($argument->hasDefaultValue()) {
+            $value = $argument->getDefaultValue();
+        } else {
+            // handle the type SessionInterface|null $param, which doesn't have a default value and can't be instantiated.
+            $value = class_exists($type, false) ? new $type() : null;
+        }
+
+        if (\is_object($value)) {
+            $request->getSession()->set($name, $value);
+        }
+
+        return [$value];
+    }
+}