Update new services with prophecy and phpstan issues

Content/Application/ContentDataMapper/DataMapper/WorkflowDataMapper.php

@@ -31,7 +31,9 @@ public function map(
     }
 
     /**
-     * @param WorkflowInterface&DimensionContentInterface $object
+     * @template T of DimensionContentInterface
+     *
+     * @param WorkflowInterface&T $object
      * @param mixed[] $data
      */
     private function setWorkflowData(WorkflowInterface $object, array $data): void
@@ -41,7 +43,9 @@ private function setWorkflowData(WorkflowInterface $object, array $data): void
     }
 
     /**
-     * @param WorkflowInterface&DimensionContentInterface $object
+     * @template T of DimensionContentInterface
+     *
+     * @param WorkflowInterface&T $object
      * @param mixed[] $data
      */
     private function setInitialPlaceToDraftDimension(WorkflowInterface $object, array $data): void
@@ -61,7 +65,9 @@ private function setInitialPlaceToDraftDimension(WorkflowInterface $object, arra
     }
 
     /**
-     * @param WorkflowInterface&DimensionContentInterface $object
+     * @template T of DimensionContentInterface
+     *
+     * @param WorkflowInterface&T $object
      * @param mixed[] $data
      */
     private function setPublishedToLiveDimension(WorkflowInterface $object, array $data): void

Content/Application/ContentWorkflow/Subscriber/UnpublishTransitionSubscriber.php

@@ -81,7 +81,7 @@ public function onUnpublish(TransitionEvent $transitionEvent): void
             $unlocalizedLiveDimensionAttributes = \array_merge($liveDimensionAttributes, ['locale' => null]);
 
             /** @var DimensionContentInterface $unlocalizedLiveDimensionContent */
-            $unlocalizedLiveDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedLiveDimensionAttributes);
+            $unlocalizedLiveDimensionContent = $dimensionContentCollection->getDimensionContent($unlocalizedLiveDimensionAttributes);  // @phpstan-ignore-line we can not define the generic of DimensionContentInterface here
             $unlocalizedLiveDimensionContent->removeAvailableLocale($locale);
         }
 

Content/Application/DimensionContentCollectionFactory/DimensionContentCollectionFactory.php

@@ -71,6 +71,7 @@ public function create(
         }
 
         $localizedDimensionContent = null;
+        /** @var string|null $locale */
         $locale = $dimensionAttributes['locale'] ?? null;
         if ($locale) {
             $localizedDimensionContent = $dimensionContentCollection->getDimensionContent($dimensionAttributes);

Content/Infrastructure/Doctrine/DimensionContentQueryEnhancer.php

@@ -76,7 +76,9 @@ public function __construct(
      * TODO it should be possible to add custom filters for all contents here example when the
      *     excerpt tab and entity get extended with an additional field.
      *
-     * @param class-string<DimensionContentInterface> $dimensionContentClassName
+     * @template T of DimensionContentInterface
+     *
+     * @param class-string<T> $dimensionContentClassName
      * @param array{
      *     locale?: string|null,
      *     stage?: string|null,
@@ -238,7 +240,9 @@ private function addJoinFilter(
      * TODO it should be possible to add custom select for all contents here example when the
      *     excerpt tab and entity get extended with additional relation.
      *
-     * @param class-string<DimensionContentInterface> $dimensionContentClassName
+     * @template T of DimensionContentInterface
+     *
+     * @param class-string<T> $dimensionContentClassName
      * @param mixed[] $dimensionAttributes
      * @param array{
      *     content_admin?: bool,

Content/Infrastructure/Doctrine/MetadataLoader.php

@@ -127,7 +127,7 @@ public function loadClassMetadata(LoadClassMetadataEventArgs $event): void
      * @param ClassMetadataInfo<object> $metadata
      * @param class-string $class
      */
-    private function addManyToOne(// @phpstan-ignore-line ignore unused method
+    private function addManyToOne(
         LoadClassMetadataEventArgs $event,
         ClassMetadataInfo $metadata,
         string $name,

Content/Infrastructure/Doctrine/RouteRemover.php

@@ -82,7 +82,7 @@ public function preRemove(LifecycleEventArgs $event): void
             return;
         }
 
-        foreach ($this->routeRepository->findAllByEntity($entityClass, $object->getId()) as $route) {
+        foreach ($this->routeRepository->findAllByEntity($entityClass, (string) $object->getId()) as $route) {
             $event->getEntityManager()->remove($route);
         }
     }

Content/Infrastructure/Sulu/Admin/ContentViewBuilderFactory.php

@@ -297,6 +297,7 @@ private function createSettingsFormView(
         string $dimensionContentClass
     ): ViewBuilderInterface {
         $forms = [];
+        /** @var array{instanceOf: class-string} $tag */
         foreach ($this->settingsForms as $key => $tag) {
             if (\is_subclass_of($dimensionContentClass, $tag['instanceOf'])) {
                 $forms[] = $key;

Content/Infrastructure/Sulu/Link/ContentLinkProvider.php

@@ -24,6 +24,9 @@
 use Sulu\Bundle\MarkupBundle\Markup\Link\LinkProviderInterface;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
 
+/**
+ * @template T of ContentRichEntityInterface
+ */
 abstract class ContentLinkProvider implements LinkProviderInterface
 {
     use FindContentRichEntitiesTrait;
@@ -46,10 +49,13 @@ abstract class ContentLinkProvider implements LinkProviderInterface
     protected $entityManager;
 
     /**
-     * @var string
+     * @var class-string<T>
      */
     protected $contentRichEntityClass;
 
+    /**
+     * @param class-string<T> $contentRichEntityClass
+     */
     public function __construct(
         ContentManagerInterface $contentManager,
         StructureMetadataFactoryInterface $structureMetadataFactory,

Content/Infrastructure/Sulu/Traits/FindContentRichEntitiesTrait.php

@@ -17,12 +17,17 @@
 use Sulu\Bundle\ContentBundle\Content\Application\ContentWorkflow\ContentWorkflowInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
 
+/**
+ * @template T of ContentRichEntityInterface
+ *
+ * @internal
+ */
 trait FindContentRichEntitiesTrait
 {
     /**
      * @param string[]|int[] $ids
      *
-     * @return ContentRichEntityInterface[]
+     * @return T[]
      */
     protected function findEntitiesByIds(array $ids): array
     {
@@ -56,6 +61,9 @@ function(ContentRichEntityInterface $a, ContentRichEntityInterface $b) use ($idP
 
     abstract protected function getEntityIdField(): string;
 
+    /**
+     * @return class-string<T>
+     */
     abstract protected function getContentRichEntityClass(): string;
 
     abstract protected function getEntityManager(): EntityManagerInterface;

Content/Infrastructure/Sulu/Traits/ResolveContentDimensionUrlTrait.php

@@ -17,6 +17,9 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\TemplateInterface;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
 
+/**
+ * @internal
+ */
 trait ResolveContentDimensionUrlTrait
 {
     /**

Content/Infrastructure/Sulu/Traits/ResolveContentTrait.php

@@ -18,6 +18,9 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 
+/**
+ * @internal
+ */
 trait ResolveContentTrait
 {
     protected function resolveContent(ContentRichEntityInterface $contentRichEntity, string $locale, bool $showDrafts = false): ?DimensionContentInterface

Tests/Application/ExampleTestBundle/Entity/Example.php

@@ -31,12 +31,12 @@ class Example implements ContentRichEntityInterface
     public const TEMPLATE_TYPE = 'example';
 
     /**
-     * @var int|string
+     * @var int
      */
     public $id;
 
     /**
-     * @return int|string
+     * @return int
      */
     public function getId()
     {

Tests/Functional/Content/Infrastructure/Sulu/Link/ContentLinkProviderTest.php

@@ -101,11 +101,11 @@ public static function setUpBeforeClass(): void
 
         static::getEntityManager()->flush();
 
-        static::$exampleIds[] = $example1->getId();
-        static::$exampleIds[] = $example2->getId();
-        static::$exampleIds[] = $example3->getId();
-        static::$exampleIds[] = $example4->getId();
-        static::$exampleIds[] = $example5->getId();
+        self::$exampleIds[] = $example1->getId();
+        self::$exampleIds[] = $example2->getId();
+        self::$exampleIds[] = $example3->getId();
+        self::$exampleIds[] = $example4->getId();
+        self::$exampleIds[] = $example5->getId();
     }
 
     protected function setUp(): void
@@ -124,13 +124,13 @@ public function testEmpty(): void
 
     public function testPreloadDE(): void
     {
-        $links = $this->exampleLinkProvider->preload(static::$exampleIds, 'de');
+        $links = $this->exampleLinkProvider->preload(self::$exampleIds, 'de');
         $this->assertArraySnapshot('links_de.json', $this->mapLinks($links));
     }
 
     public function testPreloadEN(): void
     {
-        $links = $this->exampleLinkProvider->preload(static::$exampleIds, 'en');
+        $links = $this->exampleLinkProvider->preload(self::$exampleIds, 'en');
         $this->assertArraySnapshot('links_en.json', $this->mapLinks($links));
     }
 

Tests/Unit/Content/Application/ContentDataMapper/DataMapper/AuthorDataMapperTest.php

@@ -15,6 +15,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\ContactBundle\Entity\Contact;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentDataMapper\DataMapper\AuthorDataMapper;
@@ -25,8 +26,10 @@
 
 class AuthorDataMapperTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
-     * @var ObjectProphecy|ContactFactoryInterface
+     * @var ObjectProphecy<ContactFactoryInterface>
      */
     private $contactFactory;
 

Tests/Unit/Content/Application/ContentDataMapper/DataMapper/WebspaceDataMapperTest.php

@@ -14,6 +14,7 @@
 namespace Sulu\Bundle\ContentBundle\Tests\Unit\Content\Application\ContentDataMapper\DataMapper;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentDataMapper\DataMapper\WebspaceDataMapper;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
@@ -25,8 +26,10 @@
 
 class WebspaceDataMapperTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
-     * @var ObjectProphecy|WebspaceManagerInterface
+     * @var ObjectProphecy<WebspaceManagerInterface>
      */
     private $webspaceManager;
 

Tests/Unit/Content/Application/ContentMerger/Merger/AuthorMergerTest.php

@@ -15,6 +15,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Sulu\Bundle\ContactBundle\Entity\ContactInterface;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\AuthorMerger;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\MergerInterface;
@@ -23,6 +24,8 @@
 
 class AuthorMergerTest extends TestCase
 {
+    use ProphecyTrait;
+
     protected function getAuthorMergerInstance(): MergerInterface
     {
         return new AuthorMerger();

Tests/Unit/Content/Application/ContentMerger/Merger/WebspaceMergerTest.php

@@ -15,13 +15,16 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\MergerInterface;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentMerger\Merger\WebspaceMerger;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\WebspaceInterface;
 
 class WebspaceMergerTest extends TestCase
 {
+    use ProphecyTrait;
+
     protected function getWebspaceMergerInstance(): MergerInterface
     {
         return new WebspaceMerger();

Tests/Unit/Content/Application/ContentNormalizer/Normalizer/AuthorNormalizerTest.php

@@ -14,12 +14,15 @@
 namespace Sulu\Bundle\ContentBundle\Tests\Unit\Content\Application\ContentNormalizer\Normalizer;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Sulu\Bundle\ContactBundle\Entity\ContactInterface;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentNormalizer\Normalizer\AuthorNormalizer;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\AuthorInterface;
 
 class AuthorNormalizerTest extends TestCase
 {
+    use ProphecyTrait;
+
     protected function createAuthorNormalizerInstance(): AuthorNormalizer
     {
         return new AuthorNormalizer();

Tests/Unit/Content/Domain/Model/AuthorTraitTest.php

@@ -14,12 +14,15 @@
 namespace Sulu\Bundle\ContentBundle\Tests\Unit\Content\Domain\Model;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Sulu\Bundle\ContactBundle\Entity\ContactInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\AuthorInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\AuthorTrait;
 
 class AuthorTraitTest extends TestCase
 {
+    use ProphecyTrait;
+
     protected function getAuthorInstance(): AuthorInterface
     {
         return new class() implements AuthorInterface {

Tests/Unit/Content/Infrastructure/Doctrine/RouteRemoverTest.php

@@ -18,6 +18,7 @@
 use Doctrine\ORM\Events;
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\ContentBundle\Content\Application\ContentMetadataInspector\ContentMetadataInspectorInterface;
 use Sulu\Bundle\ContentBundle\Content\Infrastructure\Doctrine\RouteRemover;
@@ -28,18 +29,20 @@
 
 class RouteRemoverTest extends TestCase
 {
+    use ProphecyTrait;
+
     public static function getResourceKey(): string
     {
         return 'test';
     }
 
     /**
-     * @var ContentMetadataInspectorInterface|ObjectProphecy
+     * @var ObjectProphecy<ContentMetadataInspectorInterface>
      */
     private $contentMetadataInspector;
 
     /**
-     * @var RouteRepositoryInterface|ObjectProphecy
+     * @var ObjectProphecy<RouteRepositoryInterface>
      */
     private $routeRepository;
 

Tests/Unit/Content/Infrastructure/Sulu/Form/SettingsFormMetadataVisitorTest.php

@@ -15,6 +15,7 @@
 
 use PHPUnit\Framework\TestCase;
 use Prophecy\Argument;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\AdminBundle\Metadata\FormMetadata\FormMetadata;
 use Sulu\Bundle\AdminBundle\Metadata\FormMetadata\ItemMetadata;
@@ -25,8 +26,10 @@
 
 class SettingsFormMetadataVisitorTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
-     * @var ObjectProphecy|XmlFormMetadataLoader
+     * @var ObjectProphecy<XmlFormMetadataLoader>
      */
     private $xmlFormMetadataLoader;
 

Tests/Unit/Content/Infrastructure/Sulu/Page/Select/WebspaceSelectTest.php

@@ -14,6 +14,7 @@
 namespace Sulu\Bundle\ContentBundle\Tests\Unit\Content\Infrastructure\Sulu\Page\Select;
 
 use PHPUnit\Framework\TestCase;
+use Prophecy\PhpUnit\ProphecyTrait;
 use Prophecy\Prophecy\ObjectProphecy;
 use Sulu\Bundle\ContentBundle\Content\Infrastructure\Sulu\Page\Select\WebspaceSelect;
 use Sulu\Component\Webspace\Manager\WebspaceCollection;
@@ -22,8 +23,10 @@
 
 class WebspaceSelectTest extends TestCase
 {
+    use ProphecyTrait;
+
     /**
-     * @var ObjectProphecy|WebspaceManagerInterface
+     * @var ObjectProphecy<WebspaceManagerInterface>
      */
     private $webspaceManager;