IBX-6630: Allowed injecting view type into content preview controller (…

…#285) For more details see https://issues.ibexa.co/browse/IBX-6630 and #285 Allowed passing optional `viewType` query parameter for core content preview controller (`ibexa.controller.content.preview:previewContentAction`) overriding default `full` view type if needed. Key changes: * Allowed injecting view type into content preview controller * [Tests] Refactored PreviewControllerTest * [Tests] Added coverage for parametrized view type in PreviewController * [PHPStan] Dropped resolved issues from baseline
ibexa · Nov 6, 2023 · a945d7a · a945d7a
1 parent be95a52
commit a945d7a
Show file tree

Hide file tree

Showing 4 changed files with 225 additions and 341 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -11550,31 +11550,6 @@ parameters:
 			count: 1
 			path: src/lib/MVC/Symfony/ConfigDumperInterface.php
 
-		-
-			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController\\:\\:previewContentAction\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: src/lib/MVC/Symfony/Controller/Content/PreviewController.php
-
-		-
-			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController\\:\\:previewContentAction\\(\\) has parameter \\$contentId with no type specified\\.$#"
-			count: 1
-			path: src/lib/MVC/Symfony/Controller/Content/PreviewController.php
-
-		-
-			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController\\:\\:previewContentAction\\(\\) has parameter \\$language with no type specified\\.$#"
-			count: 1
-			path: src/lib/MVC/Symfony/Controller/Content/PreviewController.php
-
-		-
-			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController\\:\\:previewContentAction\\(\\) has parameter \\$siteAccessName with no type specified\\.$#"
-			count: 1
-			path: src/lib/MVC/Symfony/Controller/Content/PreviewController.php
-
-		-
-			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController\\:\\:previewContentAction\\(\\) has parameter \\$versionNo with no type specified\\.$#"
-			count: 1
-			path: src/lib/MVC/Symfony/Controller/Content/PreviewController.php
-
 		-
 			message: "#^Method Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\QueryController\\:\\:runPagingQuery\\(\\) has no return type specified\\.$#"
 			count: 1
@@ -46530,36 +46505,6 @@ parameters:
 			count: 1
 			path: tests/lib/MVC/Symfony/Component/Serializer/Stubs/SerializerStub.php
 
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Controller\\\\Content\\\\PreviewControllerTest\\:\\:testPreview\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Controller\\\\Content\\\\PreviewControllerTest\\:\\:testPreviewCanUserFail\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Controller\\\\Content\\\\PreviewControllerTest\\:\\:testPreviewDefaultSiteaccess\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
-		-
-			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Controller\\\\Content\\\\PreviewControllerTest\\:\\:testPreviewUnauthorized\\(\\) has no return type specified\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
-		-
-			message: "#^Parameter \\#7 \\$controllerChecker of class Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Content\\\\PreviewController constructor expects Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\View\\\\CustomLocationControllerChecker, PHPUnit\\\\Framework\\\\MockObject\\\\MockObject&Symfony\\\\Component\\\\Security\\\\Core\\\\Authorization\\\\AuthorizationCheckerInterface given\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
-		-
-			message: "#^Property Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\Controller\\\\Content\\\\PreviewControllerTest\\:\\:\\$controllerChecker \\(PHPUnit\\\\Framework\\\\MockObject\\\\MockObject&Symfony\\\\Component\\\\Security\\\\Core\\\\Authorization\\\\AuthorizationCheckerInterface\\) does not accept Ibexa\\\\Core\\\\MVC\\\\Symfony\\\\View\\\\CustomLocationControllerChecker&PHPUnit\\\\Framework\\\\MockObject\\\\MockObject\\.$#"
-			count: 1
-			path: tests/lib/MVC/Symfony/Controller/Controller/Content/PreviewControllerTest.php
-
 		-
 			message: "#^Method Ibexa\\\\Tests\\\\Core\\\\MVC\\\\Symfony\\\\Controller\\\\ControllerTest\\:\\:testRender\\(\\) has no return type specified\\.$#"
 			count: 1

diff --git a/src/bundle/Core/Resources/config/routing/internal.yml b/src/bundle/Core/Resources/config/routing/internal.yml
@@ -20,7 +20,7 @@ ibexa.content.view:
 
 ibexa.version.preview:
     path: /content/versionview/{contentId}/{versionNo}/{language}/site_access/{siteAccessName}
-    defaults: { _controller: ibexa.controller.content.preview:previewContentAction }
+    controller: ibexa.controller.content.preview:previewContentAction
     methods:  [GET]
 
 ibexa.content.preview.default:

diff --git a/src/lib/MVC/Symfony/Controller/Content/PreviewController.php b/src/lib/MVC/Symfony/Controller/Content/PreviewController.php
@@ -22,6 +22,7 @@
 use Ibexa\Core\MVC\Symfony\View\CustomLocationControllerChecker;
 use Ibexa\Core\MVC\Symfony\View\ViewManagerInterface;
 use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\Security\Core\Authorization\AuthorizationCheckerInterface;
 use Symfony\Component\Security\Core\Exception\AccessDeniedException;
@@ -77,12 +78,12 @@ public function __construct(
      */
     public function previewContentAction(
         Request $request,
-        $contentId,
-        $versionNo,
-        $language,
-        $siteAccessName = null,
+        int $contentId,
+        int $versionNo,
+        string $language,
+        ?string $siteAccessName = null,
         ?int $locationId = null
-    ) {
+    ): Response {
         $this->previewHelper->setPreviewActive(true);
 
         try {
@@ -112,8 +113,9 @@ public function previewContentAction(
         }
 
         try {
+            $viewType = $request->query->get('viewType', ViewManagerInterface::VIEW_TYPE_FULL);
             $response = $this->kernel->handle(
-                $this->getForwardRequest($location, $content, $siteAccess, $request, $language),
+                $this->getForwardRequest($location, $content, $siteAccess, $request, $language, $viewType),
                 HttpKernelInterface::SUB_REQUEST,
                 false
             );
@@ -140,17 +142,15 @@ public function previewContentAction(
 
     /**
      * Returns the Request object that will be forwarded to the kernel for previewing the content.
-     *
-     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Location $location
-     * @param \Ibexa\Contracts\Core\Repository\Values\Content\Content $content
-     * @param \Ibexa\Core\MVC\Symfony\SiteAccess $previewSiteAccess
-     * @param \Symfony\Component\HttpFoundation\Request $request
-     * @param string $language
-     *
-     * @return \Symfony\Component\HttpFoundation\Request
      */
-    protected function getForwardRequest(Location $location, Content $content, SiteAccess $previewSiteAccess, Request $request, $language)
-    {
+    protected function getForwardRequest(
+        Location $location,
+        Content $content,
+        SiteAccess $previewSiteAccess,
+        Request $request,
+        string $language,
+        string $viewType = ViewManagerInterface::VIEW_TYPE_FULL
+    ): Request {
         $forwardRequestParameters = [
             '_controller' => UrlAliasRouter::VIEW_ACTION,
             // specify a route for RouteReference generator
@@ -161,7 +161,7 @@ protected function getForwardRequest(Location $location, Content $content, SiteA
             ],
             'location' => $location,
             'content' => $content,
-            'viewType' => ViewManagerInterface::VIEW_TYPE_FULL,
+            'viewType' => $viewType,
             'layout' => true,
             'params' => [
                 'content' => $content,