Add typehints for factories (#538)

* feat: add typehints for factories * Trigger GitHub actions Co-authored-by: Christopher Georg <christopher.georg@sr-travel.de>
Payum · Mar 2, 2022 · 8cd9755 · 8cd9755
1 parent 588c93e
commit 8cd9755
Show file tree

Hide file tree

Showing 7 changed files with 24 additions and 71 deletions.
diff --git a/DependencyInjection/Factory/Storage/AbstractStorageFactory.php b/DependencyInjection/Factory/Storage/AbstractStorageFactory.php
@@ -10,7 +10,7 @@ abstract class AbstractStorageFactory implements StorageFactoryInterface
     /**
      * {@inheritDoc}
      */
-    public function create(ContainerBuilder $container, $modelClass, array $config)
+    public function create(ContainerBuilder $container, $modelClass, array $config): string
     {
         $storageId = sprintf('payum.storage.%s', strtolower(str_replace(array('\\\\', '\\'), '_', $modelClass)));
 
@@ -22,19 +22,9 @@ public function create(ContainerBuilder $container, $modelClass, array $config)
         return $storageId;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function addConfiguration(ArrayNodeDefinition $builder)
+    public function addConfiguration(ArrayNodeDefinition $builder): void
     {
     }
 
-    /**
-     * @param ContainerBuilder $container
-     * @param string $modelClass
-     * @param array $config
-     *
-     * @return Definition
-     */
-    abstract protected function createStorage(ContainerBuilder $container, $modelClass, array $config);
+    abstract protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): Definition;
 }
diff --git a/DependencyInjection/Factory/Storage/CustomStorageFactory.php b/DependencyInjection/Factory/Storage/CustomStorageFactory.php
@@ -10,23 +10,17 @@ class CustomStorageFactory extends AbstractStorageFactory
     /**
      * {@inheritDoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return 'custom';
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function createStorage(ContainerBuilder $container, $modelClass, array $config)
+    protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): ChildDefinition
     {
         return new ChildDefinition($config['service']);
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function addConfiguration(ArrayNodeDefinition $builder)
+    public function addConfiguration(ArrayNodeDefinition $builder): void
     {
         parent::addConfiguration($builder);
 

diff --git a/DependencyInjection/Factory/Storage/DoctrineStorageFactory.php b/DependencyInjection/Factory/Storage/DoctrineStorageFactory.php
@@ -12,15 +12,12 @@ class DoctrineStorageFactory extends AbstractStorageFactory
     /**
      * {@inheritDoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return 'doctrine';
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function addConfiguration(ArrayNodeDefinition $builder)
+    public function addConfiguration(ArrayNodeDefinition $builder): void
     {
         parent::addConfiguration($builder);
 
@@ -33,10 +30,7 @@ public function addConfiguration(ArrayNodeDefinition $builder)
             ->end();
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    protected function createStorage(ContainerBuilder $container, $modelClass, array $config)
+    protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): ChildDefinition
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/storage'));
         $loader->load('doctrine.'.$config['driver'].'.xml');
@@ -47,4 +41,4 @@ protected function createStorage(ContainerBuilder $container, $modelClass, array
 
         return $storage;
     }
-}
+}
diff --git a/DependencyInjection/Factory/Storage/FilesystemStorageFactory.php b/DependencyInjection/Factory/Storage/FilesystemStorageFactory.php
@@ -12,15 +12,12 @@ class FilesystemStorageFactory extends AbstractStorageFactory
     /**
      * {@inheritdoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return 'filesystem';
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function addConfiguration(ArrayNodeDefinition $builder)
+    public function addConfiguration(ArrayNodeDefinition $builder): void
     {
         parent::addConfiguration($builder);
 
@@ -30,10 +27,7 @@ public function addConfiguration(ArrayNodeDefinition $builder)
         ->end();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    protected function createStorage(ContainerBuilder $container, $modelClass, array $config)
+    protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): ChildDefinition
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/storage'));
         $loader->load('filesystem.xml');
@@ -46,4 +40,4 @@ protected function createStorage(ContainerBuilder $container, $modelClass, array
 
         return $storage;
     }
-}
+}
diff --git a/DependencyInjection/Factory/Storage/Propel1StorageFactory.php b/DependencyInjection/Factory/Storage/Propel1StorageFactory.php
@@ -1,29 +1,22 @@
 <?php
-
 namespace Payum\Bundle\PayumBundle\DependencyInjection\Factory\Storage;
 
-
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\Config\FileLocator;
 
-
-class Propel1StorageFactory  extends AbstractStorageFactory
+class Propel1StorageFactory extends AbstractStorageFactory
 {
-
     /**
      * {@inheritDoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return "propel1";
     }
-
-    /**
-     * {@inheritDoc}
-     */
-    protected function createStorage(ContainerBuilder $container, $modelClass, array $config)
+
+    protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): ChildDefinition
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/storage'));
         $loader->load('propel1.xml');

diff --git a/DependencyInjection/Factory/Storage/Propel2StorageFactory.php b/DependencyInjection/Factory/Storage/Propel2StorageFactory.php
@@ -1,29 +1,22 @@
 <?php
-
 namespace Payum\Bundle\PayumBundle\DependencyInjection\Factory\Storage;
 
-
 use Symfony\Component\DependencyInjection\ChildDefinition;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\Config\FileLocator;
 
-
 class Propel2StorageFactory  extends AbstractStorageFactory
 {
-
     /**
      * {@inheritDoc}
      */
-    public function getName()
+    public function getName(): string
     {
         return "propel2";
     }
-
-    /**
-     * {@inheritDoc}
-     */
-    protected function createStorage(ContainerBuilder $container, $modelClass, array $config)
+
+    protected function createStorage(ContainerBuilder $container, string $modelClass, array $config): ChildDefinition
     {
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../../../Resources/config/storage'));
         $loader->load('propel2.xml');

diff --git a/DependencyInjection/Factory/Storage/StorageFactoryInterface.php b/DependencyInjection/Factory/Storage/StorageFactoryInterface.php
@@ -7,26 +7,21 @@
 interface StorageFactoryInterface
 {
     /**
-     * @param ContainerBuilder $container
      * @param string $modelClass
-     * @param array $config
-     *
      * @return string The payment serviceId
      */
     function create(ContainerBuilder $container, $modelClass, array $config);
 
     /**
-     * The storage name, 
+     * The storage name,
      * For example filesystem, doctrine, propel etc.
-     * 
+     *
      * @return string
      */
     function getName();
 
     /**
-     * @param ArrayNodeDefinition $builder
-     * 
      * @return void
      */
     function addConfiguration(ArrayNodeDefinition $builder);
-}
+}