Add global page model for fragments (see contao#2506)

Description
-----------

| Q                | A
| -----------------| ---
| Fixed issues     | Fixes contao#1935

As discussed on Mumble on the 2020-11-19, this should make the (global) page model available in the fragment controllers.

Commits
-------

03e7c41 Add global page model for fragments (replaces contao#1935)
a5c2326 Cast values for comparison
826748d Added unit tests
00eeb72 CS
29ea202 CS
0e09e4e Merge branch '4.9' into bugfix/page-argument

Author: aschempp

core-bundle/src/Controller/AbstractFragmentController.php

@@ -15,6 +15,7 @@
 use Contao\CoreBundle\Fragment\FragmentOptionsAwareInterface;
 use Contao\FrontendTemplate;
 use Contao\Model;
+use Contao\PageModel;
 use Contao\StringUtil;
 use Contao\Template;
 use Symfony\Component\DependencyInjection\Container;
@@ -26,11 +27,26 @@ abstract class AbstractFragmentController extends AbstractController implements
      */
     protected $options = [];
 
+    /**
+     * @var PageModel|null
+     */
+    private $pageModel;
+
     public function setFragmentOptions(array $options): void
     {
         $this->options = $options;
     }
 
+    protected function setPageModel(?PageModel $pageModel): void
+    {
+        $this->pageModel = $pageModel;
+    }
+
+    protected function getPageModel(): ?PageModel
+    {
+        return $this->pageModel;
+    }
+
     /**
      * Creates a template by name or from the "customTpl" field of the model.
      */

core-bundle/src/Controller/ContentElement/AbstractContentElementController.php

@@ -14,14 +14,17 @@
 
 use Contao\ContentModel;
 use Contao\CoreBundle\Controller\AbstractFragmentController;
+use Contao\PageModel;
 use Contao\Template;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 
 abstract class AbstractContentElementController extends AbstractFragmentController
 {
-    public function __invoke(Request $request, ContentModel $model, string $section, array $classes = null): Response
+    public function __invoke(Request $request, ContentModel $model, string $section, array $classes = null, PageModel $pageModel = null): Response
     {
+        $this->setPageModel($pageModel);
+
         $type = $this->getType();
         $template = $this->createTemplate($model, 'ce_'.$type);
 

core-bundle/src/Controller/FrontendModule/AbstractFrontendModuleController.php

@@ -16,19 +16,22 @@
 use Contao\CoreBundle\Controller\AbstractFragmentController;
 use Contao\CoreBundle\Routing\ScopeMatcher;
 use Contao\ModuleModel;
+use Contao\PageModel;
 use Contao\Template;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Contracts\Translation\TranslatorInterface;
 
 abstract class AbstractFrontendModuleController extends AbstractFragmentController
 {
-    public function __invoke(Request $request, ModuleModel $model, string $section, array $classes = null): Response
+    public function __invoke(Request $request, ModuleModel $model, string $section, array $classes = null, PageModel $pageModel = null): Response
     {
         if ($this->get('contao.routing.scope_matcher')->isBackendRequest($request)) {
             return $this->getBackendWildcard($model);
         }
 
+        $this->setPageModel($pageModel);
+
         $type = $this->getType();
         $template = $this->createTemplate($model, 'mod_'.$type);
 

core-bundle/src/HttpKernel/ModelArgumentResolver.php

@@ -15,6 +15,7 @@
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Routing\ScopeMatcher;
 use Contao\Model;
+use Contao\PageModel;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Controller\ArgumentValueResolverInterface;
 use Symfony\Component\HttpKernel\ControllerMetadata\ArgumentMetadata;
@@ -79,6 +80,16 @@ private function fetchModel(Request $request, ArgumentMetadata $argument): ?Mode
             return $value;
         }
 
+        // Special handling for pageModel that could be globally registered
+        if (
+            isset($GLOBALS['objPage'])
+            && $GLOBALS['objPage'] instanceof PageModel
+            && (int) $GLOBALS['objPage']->id === (int) $value
+            && is_a($type, PageModel::class, true)
+        ) {
+            return $GLOBALS['objPage'];
+        }
+
         /** @var Model $model */
         $model = $this->framework->getAdapter($argument->getType());
 

core-bundle/tests/HttpKernel/ModelArgumentResolverTest.php

@@ -13,6 +13,7 @@
 namespace Contao\CoreBundle\Tests\HttpKernel;
 
 use Contao\CoreBundle\ContaoCoreBundle;
+use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\HttpKernel\ModelArgumentResolver;
 use Contao\CoreBundle\Tests\TestCase;
 use Contao\PageModel;
@@ -27,6 +28,8 @@ class ModelArgumentResolverTest extends TestCase
      */
     public function testResolvesTheModel(string $name, string $class): void
     {
+        unset($GLOBALS['objPage']);
+
         System::setContainer($this->getContainerWithContaoConfiguration());
 
         $pageModel = $this->createMock(PageModel::class);
@@ -159,4 +162,34 @@ public function testChecksIfTheModelExistsIfTheArgumentIsNotNullable(): void
 
         $this->assertFalse($resolver->supports($request, $argument));
     }
+
+    public function testReturnsTheGlobalPageModel(): void
+    {
+        $framework = $this->createMock(ContaoFramework::class);
+        $framework
+            ->expects($this->once())
+            ->method('initialize')
+        ;
+
+        $framework
+            ->expects($this->never())
+            ->method('getAdapter')
+        ;
+
+        $pageModel = $this->mockClassWithProperties(PageModel::class, ['id' => 42]);
+        $GLOBALS['objPage'] = $pageModel;
+
+        $request = Request::create('/foobar');
+        $request->attributes->set('pageModel', 42);
+        $request->attributes->set('_scope', ContaoCoreBundle::SCOPE_FRONTEND);
+
+        $argument = new ArgumentMetadata('pageModel', PageModel::class, false, false, '', true);
+        $resolver = new ModelArgumentResolver($framework, $this->mockScopeMatcher());
+
+        $this->assertTrue($resolver->supports($request, $argument));
+
+        foreach ($resolver->resolve($request, $argument) as $model) {
+            $this->assertSame($pageModel, $model);
+        }
+    }
 }