Replace "@var Adapter" with something the IDE and PhpStan understand

AlexejKossmann · Jul 19, 2020 · 351c32f · 351c32f
1 parent d9a259a
commit 351c32f
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 15 deletions.
diff --git a/core-bundle/src/EventListener/DataContainer/ContentCompositionListener.php b/core-bundle/src/EventListener/DataContainer/ContentCompositionListener.php
@@ -14,7 +14,6 @@
 
 use Contao\Backend;
 use Contao\BackendUser;
-use Contao\CoreBundle\Framework\Adapter;
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Routing\Page\PageRegistry;
 use Contao\CoreBundle\Security\ContaoCorePermissions;
@@ -64,12 +63,12 @@ class ContentCompositionListener implements ServiceAnnotationInterface
     private $requestStack;
 
     /**
-     * @var Adapter
+     * @var Image
      */
     private $image;
 
     /**
-     * @var Adapter
+     * @var Backend
      */
     private $backend;
 
@@ -82,8 +81,13 @@ public function __construct(ContaoFramework $framework, Security $security, Page
         $this->connection = $connection;
         $this->requestStack = $requestStack;
 
-        $this->image = $this->framework->getAdapter(Image::class);
-        $this->backend = $this->framework->getAdapter(Backend::class);
+        /** @var Image $image */
+        $image = $this->framework->getAdapter(Image::class);
+        $this->image = $image;
+
+        /** @var Backend $backend */
+        $backend = $this->framework->getAdapter(Backend::class);
+        $this->backend = $backend;
     }
 
     /**

diff --git a/core-bundle/tests/Controller/Page/RootPageControllerTest.php b/core-bundle/tests/Controller/Page/RootPageControllerTest.php
@@ -14,7 +14,6 @@
 
 use Contao\CoreBundle\Controller\Page\RootPageController;
 use Contao\CoreBundle\Exception\NoActivePageFoundException;
-use Contao\CoreBundle\Framework\Adapter;
 use Contao\CoreBundle\Routing\Page\CompositionAwareInterface;
 use Contao\CoreBundle\Routing\Page\PageRoute;
 use Contao\CoreBundle\Routing\Page\PageRouteEnhancerInterface;
@@ -31,7 +30,7 @@
 class RootPageControllerTest extends TestCase
 {
     /**
-     * @var Adapter
+     * @var PageModel&MockObject
      */
     private $pageModelAdapter;
 
@@ -52,7 +51,10 @@ class RootPageControllerTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->pageModelAdapter = $this->mockAdapter(['findFirstPublishedByPid']);
+        /** @var PageModel&MockObject $pageModelAdapter */
+        $pageModelAdapter = $this->mockAdapter(['findFirstPublishedByPid']);
+        $this->pageModelAdapter = $pageModelAdapter;
+
         $this->connection = $this->createMock(Connection::class);
         $this->router = $this->createMock(UrlGeneratorInterface::class);
 

diff --git a/core-bundle/tests/EventListener/DataContainer/ContentCompositionListenerTest.php b/core-bundle/tests/EventListener/DataContainer/ContentCompositionListenerTest.php
@@ -15,7 +15,6 @@
 use Contao\Backend;
 use Contao\BackendUser;
 use Contao\CoreBundle\EventListener\DataContainer\ContentCompositionListener;
-use Contao\CoreBundle\Framework\Adapter;
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Routing\Page\PageRegistry;
 use Contao\CoreBundle\Security\ContaoCorePermissions;
@@ -66,17 +65,17 @@ class ContentCompositionListenerTest extends TestCase
     private $security;
 
     /**
-     * @var Adapter
+     * @var Image&MockObject
      */
     private $imageAdapter;
 
     /**
-     * @var Adapter
+     * @var Backend&MockObject
      */
     private $backendAdapter;
 
     /**
-     * @var Adapter
+     * @var PageModel&MockObject
      */
     private $pageModelAdapter;
 
@@ -110,9 +109,18 @@ protected function setUp(): void
         $GLOBALS['TL_DCA']['tl_article']['config']['ptable'] = 'tl_page';
 
         $this->security = $this->createMock(Security::class);
-        $this->imageAdapter = $this->mockAdapter(['getHtml']);
-        $this->backendAdapter = $this->mockAdapter(['addToUrl']);
-        $this->pageModelAdapter = $this->mockAdapter(['findByPk']);
+
+        /** @var Image&MockObject $imageAdapter */
+        $imageAdapter = $this->mockAdapter(['getHtml']);
+        $this->imageAdapter = $imageAdapter;
+
+        /** @var Backend&MockObject $backendAdapter */
+        $backendAdapter = $this->mockAdapter(['addToUrl']);
+        $this->backendAdapter = $backendAdapter;
+
+        /** @var PageModel&MockObject $pageModelAdapter */
+        $pageModelAdapter = $this->mockAdapter(['findByPk']);
+        $this->pageModelAdapter = $pageModelAdapter;
 
         $this->framework = $this->mockContaoFramework([
             Image::class => $this->imageAdapter,