Add ProviderInterface generic type in phpdoc

ray-di · Apr 26, 2022 · 5795c9a · 5795c9a
1 parent 94cd68e
commit 5795c9a
Show file tree

Hide file tree

Showing 5 changed files with 21 additions and 16 deletions.
diff --git a/src/AuraSqlQueryDeleteProvider.php b/src/AuraSqlQueryDeleteProvider.php
@@ -9,6 +9,9 @@
 use Ray\AuraSqlModule\Annotation\AuraSqlQueryConfig;
 use Ray\Di\ProviderInterface;
 
+/**
+ * @implements ProviderInterface<DeleteInterface>
+ */
 class AuraSqlQueryDeleteProvider implements ProviderInterface
 {
     private string $db;
@@ -26,10 +29,8 @@ public function __construct(string $db)
 
     /**
      * {@inheritdoc}
-     *
-     * @return DeleteInterface
      */
-    public function get()
+    public function get(): DeleteInterface
     {
         return (new QueryFactory($this->db))->newDelete();
     }

diff --git a/src/AuraSqlQueryInsertProvider.php b/src/AuraSqlQueryInsertProvider.php
@@ -9,6 +9,9 @@
 use Ray\AuraSqlModule\Annotation\AuraSqlQueryConfig;
 use Ray\Di\ProviderInterface;
 
+/**
+ * @implements ProviderInterface<InsertInterface>
+ */
 class AuraSqlQueryInsertProvider implements ProviderInterface
 {
     private string $db;
@@ -26,10 +29,8 @@ public function __construct(string $db)
 
     /**
      * {@inheritdoc}
-     *
-     * @return InsertInterface
      */
-    public function get()
+    public function get(): InsertInterface
     {
         return (new QueryFactory($this->db))->newInsert();
     }

diff --git a/src/AuraSqlQuerySelectProvider.php b/src/AuraSqlQuerySelectProvider.php
@@ -9,6 +9,9 @@
 use Ray\AuraSqlModule\Annotation\AuraSqlQueryConfig;
 use Ray\Di\ProviderInterface;
 
+/**
+ * @implements ProviderInterface<SelectInterface>
+ */
 class AuraSqlQuerySelectProvider implements ProviderInterface
 {
     private string $db;
@@ -26,10 +29,8 @@ public function __construct($db)
 
     /**
      * {@inheritdoc}
-     *
-     * @return SelectInterface
      */
-    public function get()
+    public function get(): SelectInterface
     {
         return (new QueryFactory($this->db))->newSelect();
     }

diff --git a/src/AuraSqlQueryUpdateProvider.php b/src/AuraSqlQueryUpdateProvider.php
@@ -9,6 +9,9 @@
 use Ray\AuraSqlModule\Annotation\AuraSqlQueryConfig;
 use Ray\Di\ProviderInterface;
 
+/**
+ * @implements ProviderInterface<UpdateInterface>
+ */
 class AuraSqlQueryUpdateProvider implements ProviderInterface
 {
     private string $db;
@@ -26,10 +29,8 @@ public function __construct($db)
 
     /**
      * {@inheritdoc}
-     *
-     * @return UpdateInterface
      */
-    public function get()
+    public function get(): UpdateInterface
     {
         return (new QueryFactory($this->db))->newUpdate();
     }

diff --git a/src/AuraSqlReplicationDbProvider.php b/src/AuraSqlReplicationDbProvider.php
@@ -5,13 +5,16 @@
 namespace Ray\AuraSqlModule;
 
 use Aura\Sql\ConnectionLocatorInterface;
-use Aura\Sql\PdoInterface;
+use Aura\Sql\ExtendedPdoInterface;
 use Ray\Di\InjectorInterface;
 use Ray\Di\ProviderInterface;
 use Ray\Di\SetContextInterface;
 
 use function assert;
 
+/**
+ * @implements ProviderInterface<ExtendedPdoInterface>
+ */
 class AuraSqlReplicationDbProvider implements ProviderInterface, SetContextInterface
 {
     private InjectorInterface $injector;
@@ -34,10 +37,8 @@ public function setContext($context): void
 
     /**
      * {@inheritdoc}
-     *
-     * @return PdoInterface
      */
-    public function get()
+    public function get(): ExtendedPdoInterface
     {
         $connectionLocator = $this->injector->getInstance(ConnectionLocatorInterface::class, $this->context);
         assert($connectionLocator instanceof ConnectionLocatorInterface);