Fix the phpDoc types

AlexejKossmann · Jul 17, 2020 · 63188d6 · 63188d6
1 parent f3cbd68
commit 63188d6
Show file tree

Hide file tree

Showing 14 changed files with 28 additions and 36 deletions.
diff --git a/core-bundle/src/EventListener/DataContainer/ContentCompositionListener.php b/core-bundle/src/EventListener/DataContainer/ContentCompositionListener.php
@@ -64,12 +64,12 @@ class ContentCompositionListener implements ServiceAnnotationInterface
     private $requestStack;
 
     /**
-     * @var Image|Adapter
+     * @var Adapter
      */
     private $image;
 
     /**
-     * @var Backend|Adapter
+     * @var Adapter
      */
     private $backend;
 

diff --git a/core-bundle/src/EventListener/DataContainer/LegacyRoutingListener.php b/core-bundle/src/EventListener/DataContainer/LegacyRoutingListener.php
@@ -20,8 +20,6 @@
 
 /**
  * @internal
- *
- * @deprecated This listener is used to handle legacy routing mode. It will be obsolete with Contao 5.
  */
 class LegacyRoutingListener implements ServiceAnnotationInterface
 {

diff --git a/core-bundle/src/EventListener/DataContainer/PageUrlListener.php b/core-bundle/src/EventListener/DataContainer/PageUrlListener.php
@@ -13,7 +13,6 @@
 namespace Contao\CoreBundle\EventListener\DataContainer;
 
 use Contao\CoreBundle\Exception\DuplicateAliasException;
-use Contao\CoreBundle\Framework\Adapter;
 use Contao\CoreBundle\Framework\ContaoFramework;
 use Contao\CoreBundle\Search\Document;
 use Contao\CoreBundle\Search\Indexer\IndexerInterface;
@@ -80,7 +79,7 @@ public function __construct(ContaoFramework $framework, Slug $slug, TranslatorIn
      */
     public function generateAlias(string $value, DataContainer $dc): string
     {
-        /** @var PageModel|Adapter $pageAdapter */
+        /** @var PageModel $pageAdapter */
         $pageAdapter = $this->framework->getAdapter(PageModel::class);
 
         /** @var PageModel $pageModel */
@@ -165,7 +164,7 @@ public function validateUrlPrefix(string $value, DataContainer $dc): string
             throw new \RuntimeException($this->translator->trans('ERR.urlPrefixExists', [$value], 'contao_default'));
         }
 
-        /** @var PageModel|Adapter $pageAdapter */
+        /** @var PageModel $pageAdapter */
         $pageAdapter = $this->framework->getAdapter(PageModel::class);
         $rootPage = $pageAdapter->findByPk($dc->id);
 
@@ -191,7 +190,7 @@ public function validateUrlSuffix($value, DataContainer $dc)
             return $value;
         }
 
-        /** @var PageModel|Adapter $pageAdapter */
+        /** @var PageModel $pageAdapter */
         $pageAdapter = $this->framework->getAdapter(PageModel::class);
         $rootPage = $pageAdapter->findByPk($dc->id);
 
@@ -234,7 +233,7 @@ private function purgeSearchIndex(int $pageId): void
      */
     private function recursiveValidatePages(int $pid, PageModel $rootPage): void
     {
-        /** @var PageModel|Adapter $pageAdapter */
+        /** @var PageModel $pageAdapter */
         $pageAdapter = $this->framework->getAdapter(PageModel::class);
         $pages = $pageAdapter->findByPid($pid);
 
@@ -285,7 +284,7 @@ private function aliasExists(string $currentAlias, int $currentId, PageModel $cu
             return false;
         }
 
-        /** @var PageModel|Adapter $pageAdapter */
+        /** @var PageModel $pageAdapter */
         $pageAdapter = $this->framework->getAdapter(PageModel::class);
         $currentUrl = $this->buildUrl($currentAlias, $currentPrefix, $currentSuffix);
 

diff --git a/core-bundle/src/Routing/FrontendLoader.php b/core-bundle/src/Routing/FrontendLoader.php
@@ -18,8 +18,8 @@
 use Symfony\Component\Routing\RouteCollection;
 
 /**
- * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
- *             Use Symfony routing instead.
+ * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0; use
+ *             Symfony routing instead.
  */
 class FrontendLoader extends Loader
 {
@@ -38,7 +38,7 @@ class FrontendLoader extends Loader
      */
     public function __construct(bool $prependLocale, string $urlSuffix = '.html')
     {
-        @trigger_error('Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated and will no longer work in Contao 5.0. Use Symfony routing instead.', E_USER_DEPRECATED);
+        @trigger_error('Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated and will no longer work in Contao 5.0. Use Symfony routing instead.', E_USER_DEPRECATED);
 
         $this->prependLocale = $prependLocale;
         $this->urlSuffix = $urlSuffix;

diff --git a/core-bundle/src/Routing/UrlGenerator.php b/core-bundle/src/Routing/UrlGenerator.php
@@ -19,8 +19,8 @@
 use Symfony\Component\Routing\RequestContext;
 
 /**
- * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0.
- *             Use the Symfony router instead.
+ * @deprecated Deprecated since Contao 4.10, to be removed in Contao 5.0; use
+ *             the Symfony router instead.
  */
 class UrlGenerator implements UrlGeneratorInterface
 {
@@ -44,7 +44,7 @@ class UrlGenerator implements UrlGeneratorInterface
      */
     public function __construct(UrlGeneratorInterface $router, ContaoFramework $framework, bool $prependLocale)
     {
-        @trigger_error('Using the Contao\CoreBundle\Routing\UrlGenerator class has been deprecated and will no longer work in Contao 5.0. Use the Symfony router instead.', E_USER_DEPRECATED);
+        @trigger_error('Using the "Contao\CoreBundle\Routing\UrlGenerator" class has been deprecated and will no longer work in Contao 5.0. Use the Symfony router instead.', E_USER_DEPRECATED);
 
         $this->router = $router;
         $this->framework = $framework;

diff --git a/core-bundle/tests/Controller/Page/RootPageControllerTest.php b/core-bundle/tests/Controller/Page/RootPageControllerTest.php
@@ -31,7 +31,7 @@
 class RootPageControllerTest extends TestCase
 {
     /**
-     * @var PageModel|Adapter|MockObject
+     * @var Adapter
      */
     private $pageModelAdapter;
 

diff --git a/core-bundle/tests/EventListener/DataContainer/ContentCompositionListenerTest.php b/core-bundle/tests/EventListener/DataContainer/ContentCompositionListenerTest.php
@@ -66,17 +66,17 @@ class ContentCompositionListenerTest extends TestCase
     private $security;
 
     /**
-     * @var Image|Adapter|MockObject
+     * @var Adapter
      */
     private $imageAdapter;
 
     /**
-     * @var Backend|Adapter|MockObject
+     * @var Adapter
      */
     private $backendAdapter;
 
     /**
-     * @var PageModel|Adapter|MockObject
+     * @var Adapter
      */
     private $pageModelAdapter;
 
@@ -110,7 +110,6 @@ 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']);

diff --git a/core-bundle/tests/EventListener/DataContainer/LegacyRoutingListenerTest.php b/core-bundle/tests/EventListener/DataContainer/LegacyRoutingListenerTest.php
@@ -95,11 +95,7 @@ public function testOverridesTheUrlPrefixWithoutPrependLocale(): void
 
     public function testOverridesTheUrlSuffix(): void
     {
-        $listener = new LegacyRoutingListener(
-            $this->createMock(TranslatorInterface::class),
-            false,
-            '.bar'
-        );
+        $listener = new LegacyRoutingListener($this->createMock(TranslatorInterface::class), false, '.bar');
 
         $this->assertSame('.bar', $listener->overrideUrlSuffix());
     }

diff --git a/core-bundle/tests/Functional/RoutingTest.php b/core-bundle/tests/Functional/RoutingTest.php
@@ -75,7 +75,7 @@ public function testResolvesAliases(array $fixtures, string $request, int $statu
      * @group legacy
      * @dataProvider getAliases
      *
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated %s.
      */
     public function testResolvesAliasesInLegacyMode(array $fixtures, string $request, int $statusCode, string $pageTitle, array $query, string $host, bool $autoItem): void
     {
@@ -389,7 +389,7 @@ public function testResolvesAliasesWithLocale(array $fixtures, string $request,
      * @group legacy
      * @dataProvider getAliasesWithLocale
      *
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated %s.
      */
     public function testResolvesAliasesWithLocaleInLegacyMode(array $fixtures, string $request, int $statusCode, string $pageTitle, array $query, string $host, bool $autoItem): void
     {
@@ -700,7 +700,7 @@ public function testResolvesAliasesWithoutUrlSuffix(array $fixtures, string $req
      * @group legacy
      * @dataProvider getAliasesWithoutUrlSuffix
      *
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated %s.
      */
     public function testResolvesAliasesWithoutUrlSuffixInLegacyMode(array $fixtures, string $request, int $statusCode, string $pageTitle, array $query, string $host, bool $autoItem): void
     {
@@ -1053,7 +1053,7 @@ public function testResolvesTheRootPageWithLocale(array $fixtures, string $reque
      * @group legacy
      * @dataProvider getRootAliasesWithLocale
      *
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated %s.
      */
     public function testResolvesTheRootPageWithLocaleInLegacyMode(array $fixtures, string $request, int $statusCode, string $pageTitle, string $acceptLanguages, string $host): void
     {

diff --git a/core-bundle/tests/Routing/Content/ArticleRouteProviderTest.php b/core-bundle/tests/Routing/Content/ArticleRouteProviderTest.php
@@ -107,7 +107,7 @@ public function testThrowsExceptionIfPageIsNotFound(): void
     }
 
     /**
-     * @return ArticleModel&MockObject $article
+     * @return ArticleModel&MockObject
      */
     private function mockArticle(array $parameters = []): ArticleModel
     {
@@ -125,7 +125,7 @@ private function mockArticle(array $parameters = []): ArticleModel
     }
 
     /**
-     * @return PageModel&MockObject $page
+     * @return PageModel&MockObject
      */
     private function mockPage(array $properties = []): PageModel
     {

diff --git a/core-bundle/tests/Routing/Content/PageRouteProviderTest.php b/core-bundle/tests/Routing/Content/PageRouteProviderTest.php
@@ -60,7 +60,7 @@ public function testCreatesParameteredContentRoute(): void
     }
 
     /**
-     * @return PageModel&MockObject $page
+     * @return PageModel&MockObject
      */
     private function mockPage(array $properties = []): PageModel
     {

diff --git a/core-bundle/tests/Routing/FrontendLoaderTest.php b/core-bundle/tests/Routing/FrontendLoaderTest.php
@@ -26,7 +26,7 @@
 class FrontendLoaderTest extends TestCase
 {
     /**
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\FrontendLoader class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\FrontendLoader" class has been deprecated %s.
      */
     public function testSupportsTheContaoFrontEndRoute(): void
     {

diff --git a/core-bundle/tests/Routing/Page/PageRouteTest.php b/core-bundle/tests/Routing/Page/PageRouteTest.php
@@ -114,7 +114,7 @@ public function testSetsProtocolIfRootPageUsesSSL(): void
     }
 
     /**
-     * @return PageModel&MockObject $page
+     * @return PageModel&MockObject
      */
     private function mockPageModel(array $properties = []): PageModel
     {

diff --git a/core-bundle/tests/Routing/UrlGeneratorTest.php b/core-bundle/tests/Routing/UrlGeneratorTest.php
@@ -28,7 +28,7 @@
 class UrlGeneratorTest extends TestCase
 {
     /**
-     * @expectedDeprecation Using the Contao\CoreBundle\Routing\UrlGenerator class has been deprecated %s.
+     * @expectedDeprecation Using the "Contao\CoreBundle\Routing\UrlGenerator" class has been deprecated %s.
      */
     public function testCanWriteTheContext(): void
     {