Refactored fragment renderers for Symfony 6

ibexa · adamwojs · Feb 4, 2025 · Oct 8, 2024 · Oct 9, 2024 · Oct 10, 2024
commit 19ce4ad653f3804caf792402bd51955de42c7381
diff --git a/src/bundle/Core/DependencyInjection/Compiler/FragmentPass.php b/src/bundle/Core/DependencyInjection/Compiler/FragmentPass.php
@@ -22,15 +22,15 @@
  */
 class FragmentPass implements CompilerPassInterface
 {
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (
             !(
                 $container->hasDefinition('fragment.listener')
                 && $container->hasDefinition(DecoratedFragmentRenderer::class)
             )
         ) {
-            return null;
+            return;
         }
 
         $fragmentListenerDef = $container->findDefinition('fragment.listener');

diff --git a/src/bundle/Core/Fragment/DecoratedFragmentRenderer.php b/src/bundle/Core/Fragment/DecoratedFragmentRenderer.php
@@ -10,17 +10,17 @@
 use Ibexa\Core\MVC\Symfony\SiteAccess;
 use Ibexa\Core\MVC\Symfony\SiteAccess\SiteAccessAware;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface;
 use Symfony\Component\HttpKernel\Fragment\RoutableFragmentRenderer;
 
 class DecoratedFragmentRenderer implements FragmentRendererInterface, SiteAccessAware
 {
     /** @var \Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface */
-    private $innerRenderer;
+    private FragmentRendererInterface $innerRenderer;
 
-    /** @var \Ibexa\Core\MVC\Symfony\SiteAccess */
-    private $siteAccess;
+    private ?SiteAccess $siteAccess;
 
     private SiteAccessSerializerInterface $siteAccessSerializer;
 
@@ -32,22 +32,20 @@ public function __construct(
         $this->siteAccessSerializer = $siteAccessSerializer;
     }
 
-    /**
-     * @param \Ibexa\Core\MVC\Symfony\SiteAccess|null $siteAccess
-     */
-    public function setSiteAccess(SiteAccess $siteAccess = null)
+    public function setSiteAccess(?SiteAccess $siteAccess = null): void
     {
         $this->siteAccess = $siteAccess;
     }
 
-    public function setFragmentPath($path)
+    public function setFragmentPath(string $path): void
     {
         if (!$this->innerRenderer instanceof RoutableFragmentRenderer) {
-            return null;
+            return;
         }
 
-        if ($this->siteAccess && $this->siteAccess->matcher instanceof SiteAccess\URILexer) {
-            $path = $this->siteAccess->matcher->analyseLink($path);
+        $matcher = $this->siteAccess?->matcher;
+        if ($matcher instanceof SiteAccess\URILexer) {
+            $path = $matcher->analyseLink($path);
         }
 
         $this->innerRenderer->setFragmentPath($path);
@@ -56,13 +54,9 @@ public function setFragmentPath($path)
     /**
      * Renders a URI and returns the Response content.
      *
-     * @param string|\Symfony\Component\HttpKernel\Controller\ControllerReference $uri A URI as a string or a ControllerReference instance
-     * @param \Symfony\Component\HttpFoundation\Request $request A Request instance
-     * @param array $options An array of options
-     *
-     * @return \Symfony\Component\HttpFoundation\Response A Response instance
+     * @param array<string, mixed> $options An array of options
      */
-    public function render($uri, Request $request, array $options = [])
+    public function render(string|ControllerReference $uri, Request $request, array $options = []): Response
     {
         if ($uri instanceof ControllerReference && $request->attributes->has('siteaccess')) {
             // Serialize a SiteAccess to get it back after.
@@ -76,10 +70,8 @@ public function render($uri, Request $request, array $options = [])
 
     /**
      * Gets the name of the strategy.
-     *
-     * @return string The strategy name
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->innerRenderer->getName();
     }

diff --git a/src/bundle/Core/Fragment/InlineFragmentRenderer.php b/src/bundle/Core/Fragment/InlineFragmentRenderer.php
@@ -10,18 +10,17 @@
 use Ibexa\Core\MVC\Symfony\SiteAccess;
 use Ibexa\Core\MVC\Symfony\SiteAccess\SiteAccessAware;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Controller\ControllerReference;
 use Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface;
 use Symfony\Component\HttpKernel\Fragment\InlineFragmentRenderer as BaseRenderer;
 use Symfony\Component\HttpKernel\Fragment\RoutableFragmentRenderer;
 
 class InlineFragmentRenderer extends BaseRenderer implements SiteAccessAware
 {
-    /** @var \Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface */
-    private $innerRenderer;
+    private FragmentRendererInterface $innerRenderer;
 
-    /** @var \Ibexa\Core\MVC\Symfony\SiteAccess */
-    private $siteAccess;
+    private SiteAccess $siteAccess;
 
     private SiteAccessSerializerInterface $siteAccessSerializer;
 
@@ -33,19 +32,22 @@ public function __construct(
         $this->siteAccessSerializer = $siteAccessSerializer;
     }
 
-    public function setFragmentPath($path)
+    public function setFragmentPath($path): void
     {
         if ($this->innerRenderer instanceof RoutableFragmentRenderer) {
             $this->innerRenderer->setFragmentPath($path);
         }
     }
 
-    public function setSiteAccess(SiteAccess $siteAccess = null)
+    public function setSiteAccess(SiteAccess $siteAccess = null): void
     {
         $this->siteAccess = $siteAccess;
     }
 
-    public function render($uri, Request $request, array $options = [])
+    /**
+     * @param array<string, mixed> $options
+     */
+    public function render(string|ControllerReference $uri, Request $request, array $options = []): Response
     {
         if ($uri instanceof ControllerReference) {
             if ($request->attributes->has('siteaccess')) {
@@ -64,7 +66,7 @@ public function render($uri, Request $request, array $options = [])
         return $this->innerRenderer->render($uri, $request, $options);
     }
 
-    public function getName()
+    public function getName(): string
     {
         return $this->innerRenderer->getName();
     }