Specify array configuration in extensions

Author: franmomu

phpstan-baseline.neon

@@ -630,31 +630,6 @@ parameters:
 			count: 4
 			path: src/Translatable/TranslatableListener.php
 
-		-
-			message: "#^Call to an undefined method Gedmo\\\\Mapping\\\\Event\\\\AdapterInterface\\:\\:insertTranslationRecord\\(\\)\\.$#"
-			count: 1
-			path: src/Translatable/TranslatableListener.php
-
-		-
-			message: "#^Call to an undefined method Gedmo\\\\Mapping\\\\Event\\\\AdapterInterface\\:\\:loadTranslations\\(\\)\\.$#"
-			count: 1
-			path: src/Translatable/TranslatableListener.php
-
-		-
-			message: "#^Call to an undefined method Gedmo\\\\Mapping\\\\Event\\\\AdapterInterface\\:\\:removeAssociatedTranslations\\(\\)\\.$#"
-			count: 1
-			path: src/Translatable/TranslatableListener.php
-
-		-
-			message: "#^Call to an undefined method Gedmo\\\\Mapping\\\\Event\\\\AdapterInterface\\:\\:setTranslationValue\\(\\)\\.$#"
-			count: 1
-			path: src/Translatable/TranslatableListener.php
-
-		-
-			message: "#^Call to an undefined method Gedmo\\\\Mapping\\\\Event\\\\AdapterInterface\\:\\:usesPersonalTranslation\\(\\)\\.$#"
-			count: 2
-			path: src/Translatable/TranslatableListener.php
-
 		-
 			message: "#^Negated boolean expression is always false\\.$#"
 			count: 1

src/Loggable/LoggableListener.php

@@ -11,6 +11,7 @@
 
 use Doctrine\Common\EventArgs;
 use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
+use Doctrine\Persistence\ObjectManager;
 use Gedmo\Loggable\Mapping\Event\LoggableAdapter;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
@@ -20,6 +21,17 @@
  *
  * @author Boussekeyt Jules <[email protected]>
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @phpstan-type LoggableConfiguration = array{
+ *   loggable?: bool,
+ *   logEntryClass?: class-string,
+ *   useObjectClass?: class-string,
+ *   versioned?: string[],
+ * }
+ *
+ * @phpstan-method LoggableConfiguration getConfiguration(ObjectManager $objectManager, $class)
+ *
+ * @method LoggableAdapter getEventAdapter(EventArgs $args)
  */
 class LoggableListener extends MappedEventSubscriber
 {

src/References/ReferencesListener.php

@@ -21,6 +21,24 @@
  * @author Gediminas Morkevicius <[email protected]>
  * @author Bulat Shakirzyanov <[email protected]>
  * @author Jonathan H. Wage <[email protected]>
+ *
+ * @phpstan-type ReferenceConfiguration = array{
+ *   field?: string,
+ *   type?: string,
+ *   class?: class-string,
+ *   identifier?: string,
+ *   mappedBy?: string,
+ *   inversedBy?: string,
+ * }
+ *
+ * @phpstan-type ReferencesConfiguration = array{
+ *   referenceMany?: array<string, ReferenceConfiguration>,
+ *   referenceManyEmbed?: array<string, ReferenceConfiguration>,
+ *   referenceOne?: array<string, ReferenceConfiguration>,
+ *   useObjectClass?: class-string,
+ * }
+ *
+ * @phpstan-method ReferencesConfiguration getConfiguration(ObjectManager $objectManager, $class)
  */
 class ReferencesListener extends MappedEventSubscriber
 {

src/Sluggable/Mapping/Event/SluggableAdapter.php

@@ -11,11 +11,14 @@
 
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\AdapterInterface;
+use Gedmo\Sluggable\SluggableListener;
 
 /**
  * Doctrine event adapter for the Sluggable extension.
  *
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @phpstan-import-type SluggableConfiguration from SluggableListener
  */
 interface SluggableAdapter extends AdapterInterface
 {
@@ -25,6 +28,7 @@ interface SluggableAdapter extends AdapterInterface
      * @param object        $object
      * @param ClassMetadata $meta
      * @param string        $slug
+     * @phpstan-param SluggableConfiguration $config
      *
      * @return array
      */
@@ -36,6 +40,7 @@ public function getSimilarSlugs($object, $meta, array $config, $slug);
      * @param object $object
      * @param string $target
      * @param string $replacement
+     * @phpstan-param SluggableConfiguration $config
      *
      * @return int the number of updated records
      */
@@ -48,6 +53,7 @@ public function replaceRelative($object, array $config, $target, $replacement);
      * @param object $object
      * @param string $target
      * @param string $replacement
+     * @phpstan-param SluggableConfiguration $config
      *
      * @return int the number of updated records
      */

src/Sluggable/SluggableListener.php

@@ -27,6 +27,39 @@
  *
  * @author Gediminas Morkevicius <[email protected]>
  * @author Klein Florian <[email protected]>
+ *
+ * @phpstan-type SluggableConfiguration = array{
+ *   mappedBy?: string,
+ *   pathSeparator?: string,
+ *   slug?: string,
+ *   slugs?: array<string, array{
+ *     fields?: string[],
+ *     slug?: string,
+ *     style?: string,
+ *     dateFormat?: string,
+ *     updatable?: bool,
+ *     unique?: bool,
+ *     unique_base?: string,
+ *     separator?: string,
+ *     prefix?: string,
+ *     suffix?: string,
+ *     handlers?: array<class-string, array{
+ *       mappedBy?: string,
+ *       inverseSlugField?: string,
+ *       parentRelationField?: string,
+ *       relationClass?: class-string,
+ *       relationField?: string,
+ *       relationSlugField?: string,
+ *       separator?: string,
+ *     }>,
+ *   }>,
+ *   unique?: bool,
+ *   useObjectClass?: class-string,
+ * }
+ *
+ * @phpstan-method SluggableConfiguration getConfiguration(ObjectManager $objectManager, $class)
+ *
+ * @method SluggableAdapter getEventAdapter(EventArgs $args)
  */
 class SluggableListener extends MappedEventSubscriber
 {

src/Sortable/Mapping/Event/Adapter/ORM.php

@@ -13,12 +13,15 @@
 use Doctrine\Persistence\Mapping\ClassMetadata;
 use Gedmo\Mapping\Event\Adapter\ORM as BaseAdapterORM;
 use Gedmo\Sortable\Mapping\Event\SortableAdapter;
+use Gedmo\Sortable\SortableListener;
 
 /**
  * Doctrine event adapter for ORM adapted
  * for sortable behavior
  *
  * @author Lukas Botsch <[email protected]>
+ *
+ * @phpstan-import-type SortableRelocation from SortableListener
  */
 final class ORM extends BaseAdapterORM implements SortableAdapter
 {
@@ -48,6 +51,7 @@ public function getMaxPosition(array $config, $meta, $groups)
      * @param array $relocation
      * @param array $delta
      * @param array $config
+     * @phpstan-param SortableRelocation $relocation
      *
      * @return void
      */

src/Sortable/SortableListener.php

@@ -14,6 +14,7 @@
 use Doctrine\Common\Util\ClassUtils;
 use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\Mapping\ClassMetadata;
+use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Sortable\Mapping\Event\SortableAdapter;
 use ProxyManager\Proxy\GhostObjectInterface;
@@ -26,11 +27,33 @@
  * since it does some additional calculations on persisted objects.
  *
  * @author Lukas Botsch <[email protected]>
+ *
+ * @phpstan-type SortableConfiguration = array{
+ *   groups?: string[],
+ *   position?: string,
+ *   useObjectClass?: class-string,
+ * }
+ *
+ * @phpstan-type SortableRelocation = array{
+ *   name?: class-string,
+ *   groups?: mixed[],
+ *   deltas?: array<array{
+ *     delta: int,
+ *     exclude: int[],
+ *     start: int,
+ *     stop: int,
+ *   }>,
+ * }
+ *
+ * @phpstan-method SortableConfiguration getConfiguration(ObjectManager $objectManager, $class)
+ *
+ * @method SortableAdapter getEventAdapter(EventArgs $args)
  */
 class SortableListener extends MappedEventSubscriber
 {
     /**
      * @var array<string, array<string, mixed>>
+     * @phpstan-var array<string, SortableRelocation>
      */
     private $relocations = [];
 

src/Translatable/Entity/Repository/TranslationRepository.php

@@ -164,6 +164,7 @@ public function findTranslations($entity)
      * @param string $field
      * @param string $value
      * @param string $class
+     * @phpstan-param class-string $class
      *
      * @return object instance of $class or null if not found
      */

src/Translatable/TranslatableListener.php

@@ -14,6 +14,7 @@
 use Doctrine\ORM\ORMInvalidArgumentException;
 use Doctrine\Persistence\Event\LoadClassMetadataEventArgs;
 use Doctrine\Persistence\Mapping\ClassMetadata;
+use Doctrine\Persistence\ObjectManager;
 use Gedmo\Mapping\MappedEventSubscriber;
 use Gedmo\Tool\Wrapper\AbstractWrapper;
 use Gedmo\Translatable\Mapping\Event\TranslatableAdapter;
@@ -31,6 +32,18 @@
  * the caching is activated for metadata
  *
  * @author Gediminas Morkevicius <[email protected]>
+ *
+ * @phpstan-type TranslatableConfiguration = array{
+ *   fields?: string[],
+ *   fallback?: array<string, bool>,
+ *   locale?: string,
+ *   translationClass?: class-string,
+ *   useObjectClass?: class-string,
+ * }
+ *
+ * @phpstan-method TranslatableConfiguration getConfiguration(ObjectManager $objectManager, $class)
+ *
+ * @method TranslatableAdapter getEventAdapter(EventArgs $args)
  */
 class TranslatableListener extends MappedEventSubscriber
 {

src/Tree/Entity/Repository/NestedTreeRepository.php

@@ -921,13 +921,9 @@ private function verifyTree(array &$errors, ?object $root = null): void
 
         $identifier = $meta->getSingleIdentifierFieldName();
         if (isset($config['root'])) {
-            if (isset($config['root'])) {
-                $rootId = $meta->getReflectionProperty($config['root'])->getValue($root);
-                if (is_object($rootId)) {
-                    $rootId = $meta->getReflectionProperty($identifier)->getValue($rootId);
-                }
-            } else {
-                $rootId = null;
+            $rootId = $meta->getReflectionProperty($config['root'])->getValue($root);
+            if (is_object($rootId)) {
+                $rootId = $meta->getReflectionProperty($identifier)->getValue($rootId);
             }
         } else {
             $rootId = null;