Add more typed properties

XWB · XWB · commit afb6a618312c · 2022-08-08T22:08:56.000+02:00
diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -22,10 +22,8 @@ class Configuration implements ConfigurationInterface
 
     /**
      * If the kernel is running in debug mode.
-     *
-     * @var bool
      */
-    private $debug;
+    private bool $debug;
 
     public function __construct(bool $debug)
     {
@@ -34,10 +32,8 @@ public function __construct(bool $debug)
 
     /**
      * Generates the configuration tree.
-     *
-     * @return TreeBuilder
      */
-    public function getConfigTreeBuilder()
+    public function getConfigTreeBuilder(): TreeBuilder
     {
         $treeBuilder = new TreeBuilder('fos_elastica');
         $rootNode = $treeBuilder->getRootNode();
diff --git a/src/Doctrine/AbstractElasticaToModelTransformer.php b/src/Doctrine/AbstractElasticaToModelTransformer.php
@@ -26,25 +26,20 @@ abstract class AbstractElasticaToModelTransformer extends BaseTransformer
 {
     /**
      * Manager registry.
-     *
-     * @var ManagerRegistry
      */
-    protected $registry;
+    protected ManagerRegistry $registry;
 
     /**
      * Class of the model to map to the elastica documents.
      *
-     * @var string
      * @phpstan-var class-string
      */
-    protected $objectClass;
+    protected string $objectClass;
 
     /**
      * Optional parameters.
-     *
-     * @var array
      */
-    protected $options = [
+    protected array $options = [
         'hints' => [],
         'hydrate' => true,
         'identifier' => 'id',
diff --git a/src/Doctrine/Listener.php b/src/Doctrine/Listener.php
@@ -27,55 +27,35 @@ class Listener
 {
     /**
      * Objects scheduled for insertion.
-     *
-     * @var array
      */
-    public $scheduledForInsertion = [];
+    public array $scheduledForInsertion = [];
 
     /**
      * Objects scheduled to be updated or removed.
-     *
-     * @var array
      */
-    public $scheduledForUpdate = [];
+    public array $scheduledForUpdate = [];
 
     /**
      * IDs of objects scheduled for removal.
-     *
-     * @var array
      */
-    public $scheduledForDeletion = [];
+    public array $scheduledForDeletion = [];
     /**
      * Object persister.
-     *
-     * @var ObjectPersisterInterface
      */
-    protected $objectPersister;
+    protected ObjectPersisterInterface $objectPersister;
 
     /**
      * PropertyAccessor instance.
-     *
-     * @var PropertyAccessorInterface
      */
-    protected $propertyAccessor;
+    protected PropertyAccessorInterface $propertyAccessor;
 
     /**
      * Configuration for the listener.
-     *
-     * @var array
      */
-    private $config;
+    private array $config;
 
-    /**
-     * @var IndexableInterface
-     */
-    private $indexable;
+    private IndexableInterface $indexable;
 
-    /**
-     * Constructor.
-     *
-     * @param LoggerInterface $logger
-     */
     public function __construct(
         ObjectPersisterInterface $objectPersister,
         IndexableInterface $indexable,
diff --git a/src/Doctrine/MongoDBPagerProvider.php b/src/Doctrine/MongoDBPagerProvider.php
@@ -20,31 +20,17 @@
 
 final class MongoDBPagerProvider implements PagerProviderInterface
 {
-    /**
-     * @var string
-     */
-    private $objectClass;
-
-    /**
-     * @var ManagerRegistry
-     */
-    private $doctrine;
-
-    /**
-     * @var array
-     */
-    private $baseOptions;
-
-    /**
-     * @var RegisterListenersService
-     */
-    private $registerListenersService;
-
-    /**
-     * @param string $objectClass
-     */
-    public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
-    {
+    private string $objectClass;
+    private ManagerRegistry $doctrine;
+    private array $baseOptions;
+    private RegisterListenersService $registerListenersService;
+
+    public function __construct(
+        ManagerRegistry $doctrine,
+        RegisterListenersService $registerListenersService,
+        string $objectClass,
+        array $baseOptions
+    ) {
         $this->doctrine = $doctrine;
         $this->objectClass = $objectClass;
         $this->baseOptions = $baseOptions;
diff --git a/src/Doctrine/ORMPagerProvider.php b/src/Doctrine/ORMPagerProvider.php
@@ -24,31 +24,17 @@ final class ORMPagerProvider implements PagerProviderInterface
 {
     public const ENTITY_ALIAS = 'a';
 
-    /**
-     * @var string
-     */
-    private $objectClass;
-
-    /**
-     * @var ManagerRegistry
-     */
-    private $doctrine;
-
-    /**
-     * @var array
-     */
-    private $baseOptions;
-
-    /**
-     * @var RegisterListenersService
-     */
-    private $registerListenersService;
-
-    /**
-     * @param string $objectClass
-     */
-    public function __construct(ManagerRegistry $doctrine, RegisterListenersService $registerListenersService, $objectClass, array $baseOptions)
-    {
+    private string $objectClass;
+    private ManagerRegistry $doctrine;
+    private array $baseOptions;
+    private RegisterListenersService $registerListenersService;
+
+    public function __construct(
+        ManagerRegistry $doctrine,
+        RegisterListenersService $registerListenersService,
+        string $objectClass,
+        array $baseOptions
+    ) {
         $this->doctrine = $doctrine;
         $this->objectClass = $objectClass;
         $this->baseOptions = $baseOptions;
diff --git a/src/Doctrine/RegisterListenersService.php b/src/Doctrine/RegisterListenersService.php
@@ -22,10 +22,7 @@
 
 class RegisterListenersService
 {
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $dispatcher;
+    private EventDispatcherInterface $dispatcher;
 
     public function __construct(EventDispatcherInterface $dispatcher)
     {
diff --git a/src/Doctrine/RepositoryManager.php b/src/Doctrine/RepositoryManager.php
@@ -24,21 +24,10 @@
  */
 class RepositoryManager implements RepositoryManagerInterface
 {
-    /**
-     * @var array
-     */
-    protected $entities = [];
-
-    /** @var array */
-    protected $repositories = [];
-
-    /** @var ManagerRegistry */
-    protected $managerRegistry;
-
-    /**
-     * @var RepositoryManagerInterface
-     */
-    private $repositoryManager;
+    protected array $entities = [];
+    protected array $repositories = [];
+    protected ManagerRegistry $managerRegistry;
+    private RepositoryManagerInterface $repositoryManager;
 
     public function __construct(ManagerRegistry $managerRegistry, RepositoryManagerInterface $repositoryManager)
     {
@@ -54,7 +43,7 @@ public function addIndex(string $indexName, FinderInterface $finder, ?string $re
         throw new \LogicException(__METHOD__.' should not be called. Call addIndex on the main repository manager');
     }
 
-    public function addEntity($entityName, $indexName)
+    public function addEntity($entityName, $indexName): void
     {
         $this->entities[$entityName] = $indexName;
     }
diff --git a/src/FOSElasticaBundle.php b/src/FOSElasticaBundle.php
@@ -21,7 +21,7 @@ class FOSElasticaBundle extends Bundle
     /**
      * {@inheritdoc}
      *
-     * @return void todo: remove
+     * @return void
      */
     public function build(ContainerBuilder $container)
     {
diff --git a/src/Finder/TransformedFinder.php b/src/Finder/TransformedFinder.php
@@ -30,15 +30,8 @@
  */
 class TransformedFinder implements PaginatedFinderInterface
 {
-    /**
-     * @var SearchableInterface
-     */
-    protected $searchable;
-
-    /**
-     * @var ElasticaToModelTransformerInterface
-     */
-    protected $transformer;
+    protected SearchableInterface $searchable;
+    protected ElasticaToModelTransformerInterface $transformer;
 
     public function __construct(SearchableInterface $searchable, ElasticaToModelTransformerInterface $transformer)
     {
diff --git a/src/Index/IndexManager.php b/src/Index/IndexManager.php
@@ -15,10 +15,7 @@
 
 class IndexManager
 {
-    /**
-     * @var Index
-     */
-    private $defaultIndex;
+    private Index $defaultIndex;
 
     /**
      * @var array<string, Index>
diff --git a/src/Index/MappingBuilder.php b/src/Index/MappingBuilder.php
@@ -22,10 +22,7 @@
  */
 class MappingBuilder
 {
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $dispatcher;
+    private EventDispatcherInterface $dispatcher;
 
     public function __construct(EventDispatcherInterface $eventDispatcher)
     {
diff --git a/src/Index/Resetter.php b/src/Index/Resetter.php
@@ -22,30 +22,11 @@
  */
 class Resetter implements ResetterInterface
 {
-    /**
-     * @var AliasProcessor
-     */
-    private $aliasProcessor;
-
-    /**
-     * @var ManagerInterface
-     */
-    private $configManager;
-
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $dispatcher;
-
-    /**
-     * @var IndexManager
-     */
-    private $indexManager;
-
-    /**
-     * @var MappingBuilder
-     */
-    private $mappingBuilder;
+    private AliasProcessor $aliasProcessor;
+    private ManagerInterface $configManager;
+    private EventDispatcherInterface $dispatcher;
+    private IndexManager $indexManager;
+    private MappingBuilder $mappingBuilder;
 
     public function __construct(
         ManagerInterface $configManager,
diff --git a/src/Index/TemplateResetter.php b/src/Index/TemplateResetter.php
@@ -23,25 +23,10 @@
  */
 class TemplateResetter implements ResetterInterface
 {
-    /**
-     * @var ManagerInterface
-     */
-    private $configManager;
-
-    /**
-     * @var MappingBuilder
-     */
-    private $mappingBuilder;
-
-    /**
-     * @var Client
-     */
-    private $client;
-
-    /**
-     * @var IndexTemplateManager
-     */
-    private $indexTemplateManager;
+    private ManagerInterface $configManager;
+    private MappingBuilder $mappingBuilder;
+    private Client $client;
+    private IndexTemplateManager $indexTemplateManager;
 
     public function __construct(
         ManagerInterface $configManager,
diff --git a/src/Message/Handler/AsyncPersistPageHandler.php b/src/Message/Handler/AsyncPersistPageHandler.php
@@ -17,10 +17,7 @@
 
 class AsyncPersistPageHandler implements MessageHandlerInterface
 {
-    /**
-     * @var AsyncPagerPersister
-     */
-    private $persister;
+    private AsyncPagerPersister $persister;
 
     public function __construct(AsyncPagerPersister $persister)
     {
diff --git a/src/Persister/InPlacePagerPersister.php b/src/Persister/InPlacePagerPersister.php
@@ -27,15 +27,8 @@ final class InPlacePagerPersister implements PagerPersisterInterface
 {
     public const NAME = 'in_place';
 
-    /**
-     * @var PersisterRegistry
-     */
-    private $registry;
-
-    /**
-     * @var EventDispatcherInterface
-     */
-    private $dispatcher;
+    private PersisterRegistry $registry;
+    private EventDispatcherInterface $dispatcher;
 
     public function __construct(PersisterRegistry $registry, EventDispatcherInterface $dispatcher)
     {
diff --git a/src/Persister/Listener/FilterObjectsListener.php b/src/Persister/Listener/FilterObjectsListener.php
diff --git a/src/Persister/PagerPersisterRegistry.php b/src/Persister/PagerPersisterRegistry.php
diff --git a/src/Persister/PersisterRegistry.php b/src/Persister/PersisterRegistry.php
diff --git a/src/Provider/PagerProviderRegistry.php b/src/Provider/PagerProviderRegistry.php
diff --git a/src/Repository.php b/src/Repository.php
diff --git a/src/Subscriber/PaginateElasticaQuerySubscriber.php b/src/Subscriber/PaginateElasticaQuerySubscriber.php

Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,7 @@`
`22`	`22`
`23`	`23`	`class RegisterListenersService`
`24`	`24`	`{`
`25`		`- /**`
`26`		`- * @var EventDispatcherInterface`
`27`		`- */`
`28`		`- private $dispatcher;`
	`25`	`+ private EventDispatcherInterface $dispatcher;`
`29`	`26`
`30`	`27`	`public function __construct(EventDispatcherInterface $dispatcher)`
`31`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ class FOSElasticaBundle extends Bundle`
`21`	`21`	`/**`
`22`	`22`	`* {@inheritdoc}`
`23`	`23`	`*`
`24`		`- * @return void todo: remove`
	`24`	`+ * @return void`
`25`	`25`	`*/`
`26`	`26`	`public function build(ContainerBuilder $container)`
`27`	`27`	`{`