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

@@ -16,7 +16,6 @@
 use Doctrine\Common\Collections\Criteria;
 use Doctrine\ORM\Query\Expr\Join;
 use Doctrine\ORM\QueryBuilder;
-use Sulu\Bundle\ContentBundle\Content\Application\ContentMetadataInspector\ContentMetadataInspectorInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ExcerptInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\TemplateInterface;
@@ -29,17 +28,6 @@
  */
 class DimensionContentQueryEnhancer
 {
-    /**
-     * @var ContentMetadataInspectorInterface
-     */
-    private $contentMetadataInspector;
-
-    public function __construct(
-        ContentMetadataInspectorInterface $contentMetadataInspector
-    ) {
-        $this->contentMetadataInspector = $contentMetadataInspector;
-    }
-
     /**
      * Withs represents additional selects which can be load to join and select specific sub entities.
      * They are used by groups and fields.
@@ -76,7 +64,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 +228,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

@@ -38,12 +38,12 @@ class RouteRemover implements EventSubscriber
     private $routeRepository;
 
     /**
-     * @var array<string, array<mixed>>
+     * @var array<string|int, array{resource_key: string, entityClass?: string}>
      */
     private $routeMappings;
 
     /**
-     * @param array<string, array<mixed>> $routeMappings
+     * @param array<string|int, array{resource_key: string, entityClass?: string}> $routeMappings
      */
     public function __construct(
         ContentMetadataInspectorInterface $contentMetadataInspector,
@@ -73,6 +73,7 @@ public function preRemove(LifecycleEventArgs $event): void
         $entityClass = null;
         foreach ($this->routeMappings as $key => $mapping) {
             if ($resourceKey === $mapping['resource_key']) {
+                /** @var class-string $entityClass */
                 $entityClass = $mapping['entityClass'] ?? $key;
                 break;
             }
@@ -82,7 +83,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

@@ -51,12 +51,12 @@ class ContentViewBuilderFactory implements ContentViewBuilderFactoryInterface
     private $securityChecker;
 
     /**
-     * @var array<string, mixed[]>
+     * @var array<string, array{instanceOf: class-string}>
      */
     private $settingsForms;
 
     /**
-     * @param array<string, mixed[]> $settingsForms
+     * @param array<string, array{instanceOf: class-string}> $settingsForms
      */
     public function __construct(
         ViewBuilderFactoryInterface $viewBuilderFactory,

Content/Infrastructure/Sulu/Link/ContentLinkProvider.php

@@ -24,8 +24,15 @@
 use Sulu\Bundle\MarkupBundle\Markup\Link\LinkProviderInterface;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
 
+/**
+ * @template B of DimensionContentInterface
+ * @template T of ContentRichEntityInterface<B>
+ */
 abstract class ContentLinkProvider implements LinkProviderInterface
 {
+    /**
+     * @phpstan-use FindContentRichEntitiesTrait<T>
+     */
     use FindContentRichEntitiesTrait;
     use ResolveContentDimensionUrlTrait;
     use ResolveContentTrait;
@@ -46,10 +53,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,
@@ -73,7 +83,6 @@ public function preload(array $hrefs, $locale, $published = true): array
             \array_values(
                 \array_filter(
                     \array_map(function(ContentRichEntityInterface $contentRichEntity) use ($locale, $published) {
-                        /** @var DimensionContentInterface|null $resolvedDimensionContent */
                         $resolvedDimensionContent = $this->resolveContent($contentRichEntity, $locale, !$published);
 
                         if (!$resolvedDimensionContent) {
@@ -83,7 +92,7 @@ public function preload(array $hrefs, $locale, $published = true): array
                         $data = $this->contentManager->normalize($resolvedDimensionContent);
 
                         return new LinkItem(
-                            $contentRichEntity->getId(),
+                            (string) $contentRichEntity->getId(),
                             (string) $this->getTitle($resolvedDimensionContent, $data),
                             (string) $this->getUrl($resolvedDimensionContent, $data),
                             $published
@@ -94,6 +103,8 @@ public function preload(array $hrefs, $locale, $published = true): array
     }
 
     /**
+     * @param B $dimensionContent
+     *
      * @param mixed[] $data
      */
     protected function getTitle(DimensionContentInterface $dimensionContent, array $data): ?string
@@ -106,6 +117,9 @@ protected function getEntityIdField(): string
         return 'id';
     }
 
+    /**
+     * @return class-string<T>
+     */
     protected function getContentRichEntityClass(): string
     {
         return $this->contentRichEntityClass;

Content/Infrastructure/Sulu/Teaser/ContentTeaserProvider.php

@@ -32,6 +32,9 @@
  */
 abstract class ContentTeaserProvider implements TeaserProviderInterface
 {
+    /**
+     * @phpstan-use FindContentRichEntitiesTrait<T>
+     */
     use FindContentRichEntitiesTrait;
     use ResolveContentDimensionUrlTrait;
     use ResolveContentTrait;
@@ -241,6 +244,9 @@ protected function getEntityIdField(): string
         return 'id';
     }
 
+    /**
+     * @return class-string<T>
+     */
     protected function getContentRichEntityClass(): string
     {
         return $this->contentRichEntityClass;

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 D of ContentRichEntityInterface
+ *
+ * @internal
+ */
 trait FindContentRichEntitiesTrait
 {
     /**
      * @param string[]|int[] $ids
      *
-     * @return ContentRichEntityInterface[]
+     * @return D[]
      */
     protected function findEntitiesByIds(array $ids): array
     {
@@ -31,6 +36,7 @@ protected function findEntitiesByIds(array $ids): array
         $contentRichEntityClass = $this->getContentRichEntityClass();
         $classMetadata = $entityManager->getClassMetadata($contentRichEntityClass);
 
+        /** @var D[] $entities */
         $entities = $entityManager->createQueryBuilder()
             ->select(ContentWorkflowInterface::CONTENT_RICH_ENTITY_CONTEXT_KEY)
             ->from($contentRichEntityClass, ContentWorkflowInterface::CONTENT_RICH_ENTITY_CONTEXT_KEY)
@@ -56,6 +62,9 @@ function(ContentRichEntityInterface $a, ContentRichEntityInterface $b) use ($idP
 
     abstract protected function getEntityIdField(): string;
 
+    /**
+     * @return class-string<D>
+     */
     abstract protected function getContentRichEntityClass(): string;
 
     abstract protected function getEntityManager(): EntityManagerInterface;

Content/Infrastructure/Sulu/Traits/ResolveContentDimensionUrlTrait.php

@@ -17,9 +17,15 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\TemplateInterface;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
 
+/**
+ * @internal
+ */
 trait ResolveContentDimensionUrlTrait
 {
     /**
+     * @template C of DimensionContentInterface
+     *
+     * @param C $dimensionContent
      * @param mixed[] $data
      */
     protected function getUrl(DimensionContentInterface $dimensionContent, array $data): ?string
@@ -41,6 +47,7 @@ protected function getUrl(DimensionContentInterface $dimensionContent, array $da
 
         foreach ($metadata->getProperties() as $property) {
             if ('route' === $property->getType()) {
+                /** @var string|null */
                 return $dimensionContent->getTemplateData()[$property->getName()] ?? null;
             }
         }

Content/Infrastructure/Sulu/Traits/ResolveContentTrait.php

@@ -18,8 +18,18 @@
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\ContentRichEntityInterface;
 use Sulu\Bundle\ContentBundle\Content\Domain\Model\DimensionContentInterface;
 
+/**
+ * @internal
+ */
 trait ResolveContentTrait
 {
+    /**
+     * @template E of DimensionContentInterface
+     *
+     * @param ContentRichEntityInterface<E> $contentRichEntity
+     *
+     * @return E|null
+     */
     protected function resolveContent(ContentRichEntityInterface $contentRichEntity, string $locale, bool $showDrafts = false): ?DimensionContentInterface
     {
         $stage = $showDrafts

DependencyInjection/Compiler/SettingsFormPass.php

@@ -68,13 +68,13 @@ public function process(ContainerBuilder $container): void
 
                 $settingsForms[$key] = [
                     'instanceOf' => $instanceOf,
-                    'priority' => $priority,
+                    'priority' => (int) $priority,
                 ];
             }
         }
 
         \uasort($settingsForms, static function($a, $b) {
-            return $b['priority'] ?? 0 <=> $a['priority'] ?? 0;
+            return $b['priority'] <=> $a['priority'];
         });
 
         $container->setParameter('sulu_content.content_settings_forms', $settingsForms);

Resources/config/services.xml

@@ -90,9 +90,7 @@
 
         <service id="Sulu\Bundle\ContentBundle\Content\Domain\Repository\DimensionContentRepositoryInterface" alias="sulu_content.dimension_content_repository"/>
 
-        <service id="sulu_content.dimension_content_query_enhancer" class="Sulu\Bundle\ContentBundle\Content\Infrastructure\Doctrine\DimensionContentQueryEnhancer">
-            <argument type="service" id="sulu_content.content_metadata_inspector"/>
-        </service>
+        <service id="sulu_content.dimension_content_query_enhancer" class="Sulu\Bundle\ContentBundle\Content\Infrastructure\Doctrine\DimensionContentQueryEnhancer"/>
 
         <service id="Sulu\Bundle\ContentBundle\Content\Infrastructure\Doctrine\DimensionContentQueryEnhancer" alias="sulu_content.dimension_content_query_enhancer"/>
 

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/Application/ExampleTestBundle/Link/ExampleLinkProvider.php

@@ -17,10 +17,14 @@
 use Sulu\Bundle\ContentBundle\Content\Application\ContentManager\ContentManagerInterface;
 use Sulu\Bundle\ContentBundle\Content\Infrastructure\Sulu\Link\ContentLinkProvider;
 use Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\Example;
+use Sulu\Bundle\ContentBundle\Tests\Application\ExampleTestBundle\Entity\ExampleDimensionContent;
 use Sulu\Bundle\MarkupBundle\Markup\Link\LinkConfiguration;
 use Sulu\Bundle\MarkupBundle\Markup\Link\LinkConfigurationBuilder;
 use Sulu\Component\Content\Metadata\Factory\StructureMetadataFactoryInterface;
 
+/**
+ * @extends ContentLinkProvider<ExampleDimensionContent, Example>
+ */
 class ExampleLinkProvider extends ContentLinkProvider
 {
     public function __construct(