Fix PHPStan issues

GoneSubscriber/GoneDocumentSubscriber.php

@@ -25,6 +25,8 @@
 
 /**
  * This gone subscriber listens for removed pages.
+ *
+ * @internal this is a internal listener which should not be used directly
  */
 class GoneDocumentSubscriber implements EventSubscriberInterface
 {

GoneSubscriber/GoneEntitySubscriber.php

@@ -16,21 +16,31 @@
 use Doctrine\ORM\Events;
 use Sulu\Bundle\RedirectBundle\Entity\RedirectRoute;
 use Sulu\Bundle\RedirectBundle\Exception\RedirectRouteNotUniqueException;
-use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManager;
+use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManagerInterface;
 use Sulu\Bundle\RouteBundle\Model\RouteInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareInterface;
 use Symfony\Component\DependencyInjection\ContainerAwareTrait;
 
 /**
  * This gone subscriber listens for removed route entities.
+ *
+ * @internal this is a internal listener which should not be used directly
  */
 class GoneEntitySubscriber implements EventSubscriber, ContainerAwareInterface
 {
     use ContainerAwareTrait;
 
     /**
-     * {@inheritdoc}
+     * @var RedirectRouteManagerInterface
      */
+    private $redirectRouteManager;
+
+    public function __construct(
+        RedirectRouteManagerInterface $redirectRouteManager,
+    ) {
+        $this->redirectRouteManager = $redirectRouteManager;
+    }
+
     public function getSubscribedEvents()
     {
         return [
@@ -42,8 +52,7 @@ public function preRemove(LifecycleEventArgs $event): void
     {
         $route = $event->getObject();
 
-        $routeManager = $this->getRedirectRouteManager();
-        if (!$route instanceof RouteInterface || null === $routeManager) {
+        if (!$route instanceof RouteInterface) {
             return;
         }
 
@@ -53,21 +62,9 @@ public function preRemove(LifecycleEventArgs $event): void
         $redirectRoute->setSource($route->getPath());
 
         try {
-            $routeManager->save($redirectRoute);
+            $this->redirectRouteManager->save($redirectRoute);
         } catch (RedirectRouteNotUniqueException $exception) {
             // do nothing when there already exists a redirect route
         }
     }
-
-    /**
-     * @return RedirectRouteManager|null
-     */
-    private function getRedirectRouteManager()
-    {
-        if (null === $this->container) {
-            return null;
-        }
-
-        return $this->container->get('sulu_redirect.redirect_route_manager');
-    }
 }

Import/Converter/Converter.php

@@ -12,6 +12,7 @@
 namespace Sulu\Bundle\RedirectBundle\Import\Converter;
 
 use Ramsey\Uuid\Uuid;
+use Sulu\Bundle\RedirectBundle\Model\RedirectRouteInterface;
 use Sulu\Bundle\RedirectBundle\Model\RedirectRouteRepositoryInterface;
 use Symfony\Component\PropertyAccess\PropertyAccess;
 
@@ -49,6 +50,7 @@ public function convert(array $item)
 
         $entity = $this->repository->findBySource($item[self::SOURCE]);
         if (!$entity) {
+            /** @var RedirectRouteInterface $entity */
             $entity = $this->repository->createNew();
             $entity->setId(Uuid::uuid4()->toString());
         }

Resources/config/gone_subscriber.xml

@@ -17,9 +17,7 @@
 
         <service id="sulu_redirect.subscriber.entity"
                  class="Sulu\Bundle\RedirectBundle\GoneSubscriber\GoneEntitySubscriber">
-            <call method="setContainer">
-                <argument type="service" id="service_container"/>
-            </call>
+            <argument type="service" id="sulu_redirect.redirect_route_manager"/>
 
             <tag name="doctrine.event_subscriber"/>
         </service>

Tests/Unit/GoneSubscriber/GoneDocumentSubscriberTest.php

@@ -14,6 +14,7 @@
 use Doctrine\ORM\EntityManager;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\DocumentManagerBundle\Bridge\DocumentInspector;
 use Sulu\Bundle\PageBundle\Document\BasePageDocument;
 use Sulu\Bundle\RedirectBundle\GoneSubscriber\GoneDocumentSubscriber;
@@ -35,47 +36,47 @@ class GoneDocumentSubscriberTest extends TestCase
     private $goneDocumentSubscriber;
 
     /**
-     * @var EntityManager
+     * @var ObjectProphecy<EntityManager>
      */
     private $entityManager;
 
     /**
-     * @var RedirectRouteManager
+     * @var ObjectProphecy<RedirectRouteManager>
      */
     private $redirectRouteManager;
 
     /**
-     * @var DocumentInspector
+     * @var ObjectProphecy<DocumentInspector>
      */
     private $documentInspector;
 
     /**
-     * @var WebspaceManager
+     * @var ObjectProphecy<WebspaceManager>
      */
     private $webspaceManager;
 
     /**
-     * @var ResourceLocatorStrategyPool
+     * @var ObjectProphecy<ResourceLocatorStrategyPool>
      */
     private $resourceLocatorStrategyPool;
 
     /**
-     * @var RemoveEvent
+     * @var ObjectProphecy<RemoveEvent>
      */
     private $removeEvent;
 
     /**
-     * @var BasePageDocument
+     * @var ObjectProphecy<BasePageDocument>
      */
     private $document;
 
     /**
-     * @var ResourceLocatorStrategyInterface
+     * @var ObjectProphecy<ResourceLocatorStrategyInterface>
      */
     private $resourceLocatorStrategy;
 
     /**
-     * @var Webspace
+     * @var ObjectProphecy<Webspace>
      */
     private $webspace;
 

Tests/Unit/GoneSubscriber/GoneEntitySubscriberTest.php

@@ -14,6 +14,7 @@
 use Doctrine\ORM\Event\LifecycleEventArgs;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\RedirectBundle\Entity\RedirectRoute;
 use Sulu\Bundle\RedirectBundle\GoneSubscriber\GoneEntitySubscriber;
 use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManager;
@@ -28,25 +29,20 @@ class GoneEntitySubscriberTest extends TestCase
     private $goneEntitySubscriber;
 
     /**
-     * @var LifecycleEventArgs
+     * @var ObjectProphecy<LifecycleEventArgs>
      */
     private $event;
 
     /**
-     * @var RouteInterface
+     * @var ObjectProphecy<RouteInterface>
      */
     private $object;
 
     /**
-     * @var RedirectRouteManager
+     * @var ObjectProphecy<RedirectRouteManager>
      */
     private $redirectRouteManager;
 
-    /**
-     * @var ContainerInterface
-     */
-    private $container;
-
     protected function setUp(): void
     {
         $this->object = $this->prophesize(RouteInterface::class);
@@ -62,11 +58,7 @@ protected function setUp(): void
             return true;
         }))->shouldBeCalledTimes(1);
 
-        $this->container = $this->prophesize(ContainerInterface::class);
-        $this->container->get('sulu_redirect.redirect_route_manager')->willReturn($this->redirectRouteManager->reveal());
-
-        $this->goneEntitySubscriber = new GoneEntitySubscriber();
-        $this->goneEntitySubscriber->setContainer($this->container->reveal());
+        $this->goneEntitySubscriber = new GoneEntitySubscriber($this->redirectRouteManager->reveal());
     }
 
     public function testPreRemoveWithWrongObject()

Tests/Unit/Import/FileImportTest.php

@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\RedirectBundle\Import\Converter\Converter;
 use Sulu\Bundle\RedirectBundle\Import\Converter\ConverterInterface;
 use Sulu\Bundle\RedirectBundle\Import\Converter\ConverterNotFoundException;
@@ -28,17 +29,17 @@
 class FileImportTest extends TestCase
 {
     /**
-     * @var ReaderInterface
+     * @var ObjectProphecy<ReaderInterface>
      */
     private $reader;
 
     /**
-     * @var ConverterInterface
+     * @var ObjectProphecy<ConverterInterface>
      */
     private $converter;
 
     /**
-     * @var WriterInterface
+     * @var ObjectProphecy<WriterInterface>
      */
     private $writer;
 

Tests/Unit/Import/Writer/WriterTest.php

@@ -13,6 +13,7 @@
 
 use Doctrine\ORM\EntityManagerInterface;
 use PHPUnit\Framework\TestCase;
+use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\RedirectBundle\Exception\RedirectRouteNotUniqueException;
 use Sulu\Bundle\RedirectBundle\Import\Writer\DuplicatedSourceException;
 use Sulu\Bundle\RedirectBundle\Import\Writer\TargetIsEmptyException;
@@ -24,12 +25,12 @@
 class WriterTest extends TestCase
 {
     /**
-     * @var RedirectRouteManagerInterface
+     * @var ObjectProphecy<RedirectRouteManagerInterface>
      */
     private $redirectRouteManager;
 
     /**
-     * @var EntityManagerInterface
+     * @var ObjectProphecy<EntityManagerInterface>
      */
     private $entityManager;
 

Tests/Unit/Manager/RedirectRouteManagerTest.php

@@ -13,6 +13,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\RedirectBundle\Exception\RedirectRouteNotUniqueException;
 use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManager;
 use Sulu\Bundle\RedirectBundle\Manager\RedirectRouteManagerInterface;
@@ -22,7 +23,7 @@
 class RedirectRouteManagerTest extends TestCase
 {
     /**
-     * @var RedirectRouteRepositoryInterface
+     * @var ObjectProphecy<RedirectRouteRepositoryInterface>
      */
     private $repository;