[client] Add type hints to driver interface and its implementations.

pkg/enqueue/Client/Driver/AmqpDriver.php

@@ -12,6 +12,7 @@
 use Interop\Amqp\AmqpTopic;
 use Interop\Amqp\Impl\AmqpBind;
 use Interop\Queue\PsrMessage;
+use Interop\Queue\PsrQueue;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 
@@ -32,22 +33,14 @@ class AmqpDriver implements DriverInterface
      */
     private $queueMetaRegistry;
 
-    /**
-     * @param AmqpContext       $context
-     * @param Config            $config
-     * @param QueueMetaRegistry $queueMetaRegistry
-     */
     public function __construct(AmqpContext $context, Config $config, QueueMetaRegistry $queueMetaRegistry)
     {
         $this->context = $context;
         $this->config = $config;
         $this->queueMetaRegistry = $queueMetaRegistry;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToRouter(Message $message)
+    public function sendToRouter(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_TOPIC_NAME)) {
             throw new \LogicException('Topic name parameter is required but is not set');
@@ -59,10 +52,7 @@ public function sendToRouter(Message $message)
         $this->context->createProducer()->send($topic, $transportMessage);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToProcessor(Message $message)
+    public function sendToProcessor(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_PROCESSOR_NAME)) {
             throw new \LogicException('Processor name parameter is required but is not set');
@@ -78,10 +68,7 @@ public function sendToProcessor(Message $message)
         $this->context->createProducer()->send($destination, $transportMessage);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setupBroker(LoggerInterface $logger = null)
+    public function setupBroker(LoggerInterface $logger = null): void
     {
         $logger = $logger ?: new NullLogger();
         $log = function ($text, ...$args) use ($logger) {
@@ -109,11 +96,9 @@ public function setupBroker(LoggerInterface $logger = null)
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return AmqpQueue
      */
-    public function createQueue($queueName)
+    public function createQueue(string $queueName): PsrQueue
     {
         $transportName = $this->queueMetaRegistry->getQueueMeta($queueName)->getTransportName();
 
@@ -124,11 +109,9 @@ public function createQueue($queueName)
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return AmqpMessage
      */
-    public function createTransportMessage(Message $message)
+    public function createTransportMessage(Message $message): PsrMessage
     {
         $headers = $message->getHeaders();
         $properties = $message->getProperties();
@@ -153,10 +136,8 @@ public function createTransportMessage(Message $message)
 
     /**
      * @param AmqpMessage $message
-     *
-     * {@inheritdoc}
      */
-    public function createClientMessage(PsrMessage $message)
+    public function createClientMessage(PsrMessage $message): Message
     {
         $clientMessage = new Message();
 
@@ -177,18 +158,12 @@ public function createClientMessage(PsrMessage $message)
         return $clientMessage;
     }
 
-    /**
-     * @return Config
-     */
-    public function getConfig()
+    public function getConfig(): Config
     {
         return $this->config;
     }
 
-    /**
-     * @return AmqpTopic
-     */
-    private function createRouterTopic()
+    private function createRouterTopic(): AmqpTopic
     {
         $topic = $this->context->createTopic(
             $this->config->createTransportRouterTopicName($this->config->getRouterTopicName())

pkg/enqueue/Client/Driver/DbalDriver.php

@@ -8,8 +8,10 @@
 use Enqueue\Client\MessagePriority;
 use Enqueue\Client\Meta\QueueMetaRegistry;
 use Enqueue\Dbal\DbalContext;
+use Enqueue\Dbal\DbalDestination;
 use Enqueue\Dbal\DbalMessage;
 use Interop\Queue\PsrMessage;
+use Interop\Queue\PsrQueue;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 
@@ -41,11 +43,6 @@ class DbalDriver implements DriverInterface
         MessagePriority::VERY_HIGH => 4,
     ];
 
-    /**
-     * @param DbalContext       $context
-     * @param Config            $config
-     * @param QueueMetaRegistry $queueMetaRegistry
-     */
     public function __construct(DbalContext $context, Config $config, QueueMetaRegistry $queueMetaRegistry)
     {
         $this->context = $context;
@@ -54,11 +51,9 @@ public function __construct(DbalContext $context, Config $config, QueueMetaRegis
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return DbalMessage
      */
-    public function createTransportMessage(Message $message)
+    public function createTransportMessage(Message $message): PsrMessage
     {
         $properties = $message->getProperties();
 
@@ -88,10 +83,8 @@ public function createTransportMessage(Message $message)
 
     /**
      * @param DbalMessage $message
-     *
-     * {@inheritdoc}
      */
-    public function createClientMessage(PsrMessage $message)
+    public function createClientMessage(PsrMessage $message): Message
     {
         $clientMessage = new Message();
 
@@ -120,10 +113,7 @@ public function createClientMessage(PsrMessage $message)
         return $clientMessage;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToRouter(Message $message)
+    public function sendToRouter(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_TOPIC_NAME)) {
             throw new \LogicException('Topic name parameter is required but is not set');
@@ -135,10 +125,7 @@ public function sendToRouter(Message $message)
         $this->context->createProducer()->send($queue, $transportMessage);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToProcessor(Message $message)
+    public function sendToProcessor(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_PROCESSOR_NAME)) {
             throw new \LogicException('Processor name parameter is required but is not set');
@@ -155,19 +142,16 @@ public function sendToProcessor(Message $message)
     }
 
     /**
-     * {@inheritdoc}
+     * @return DbalDestination
      */
-    public function createQueue($queueName)
+    public function createQueue(string $queueName): PsrQueue
     {
         $transportName = $this->queueMetaRegistry->getQueueMeta($queueName)->getTransportName();
 
         return $this->context->createQueue($transportName);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setupBroker(LoggerInterface $logger = null)
+    public function setupBroker(LoggerInterface $logger = null): void
     {
         $logger = $logger ?: new NullLogger();
         $log = function ($text, ...$args) use ($logger) {
@@ -178,18 +162,12 @@ public function setupBroker(LoggerInterface $logger = null)
         $this->context->createDataBaseTable();
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function getConfig()
+    public function getConfig(): Config
     {
         return $this->config;
     }
 
-    /**
-     * @return array
-     */
-    public static function getPriorityMap()
+    public static function getPriorityMap(): array
     {
         return self::$priorityMap;
     }

pkg/enqueue/Client/Driver/FsDriver.php

@@ -11,6 +11,7 @@
 use Enqueue\Fs\FsDestination;
 use Enqueue\Fs\FsMessage;
 use Interop\Queue\PsrMessage;
+use Interop\Queue\PsrQueue;
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
 
@@ -31,22 +32,14 @@ class FsDriver implements DriverInterface
      */
     private $queueMetaRegistry;
 
-    /**
-     * @param FsContext         $context
-     * @param Config            $config
-     * @param QueueMetaRegistry $queueMetaRegistry
-     */
     public function __construct(FsContext $context, Config $config, QueueMetaRegistry $queueMetaRegistry)
     {
         $this->context = $context;
         $this->config = $config;
         $this->queueMetaRegistry = $queueMetaRegistry;
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToRouter(Message $message)
+    public function sendToRouter(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_TOPIC_NAME)) {
             throw new \LogicException('Topic name parameter is required but is not set');
@@ -58,10 +51,7 @@ public function sendToRouter(Message $message)
         $this->context->createProducer()->send($topic, $transportMessage);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function sendToProcessor(Message $message)
+    public function sendToProcessor(Message $message): void
     {
         if (false == $message->getProperty(Config::PARAMETER_PROCESSOR_NAME)) {
             throw new \LogicException('Processor name parameter is required but is not set');
@@ -77,10 +67,7 @@ public function sendToProcessor(Message $message)
         $this->context->createProducer()->send($destination, $transportMessage);
     }
 
-    /**
-     * {@inheritdoc}
-     */
-    public function setupBroker(LoggerInterface $logger = null)
+    public function setupBroker(LoggerInterface $logger = null): void
     {
         $logger = $logger ?: new NullLogger();
         $log = function ($text, ...$args) use ($logger) {
@@ -107,23 +94,19 @@ public function setupBroker(LoggerInterface $logger = null)
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return FsDestination
      */
-    public function createQueue($queueName)
+    public function createQueue(string $queueName): PsrQueue
     {
         $transportName = $this->queueMetaRegistry->getQueueMeta($queueName)->getTransportName();
 
         return $this->context->createQueue($transportName);
     }
 
     /**
-     * {@inheritdoc}
-     *
      * @return FsMessage
      */
-    public function createTransportMessage(Message $message)
+    public function createTransportMessage(Message $message): PsrMessage
     {
         $properties = $message->getProperties();
 
@@ -144,10 +127,8 @@ public function createTransportMessage(Message $message)
 
     /**
      * @param FsMessage $message
-     *
-     * {@inheritdoc}
      */
-    public function createClientMessage(PsrMessage $message)
+    public function createClientMessage(PsrMessage $message): Message
     {
         $clientMessage = new Message();
 
@@ -165,18 +146,12 @@ public function createClientMessage(PsrMessage $message)
         return $clientMessage;
     }
 
-    /**
-     * @return Config
-     */
-    public function getConfig()
+    public function getConfig(): Config
     {
         return $this->config;
     }
 
-    /**
-     * @return FsDestination
-     */
-    private function createRouterTopic()
+    private function createRouterTopic(): FsDestination
     {
         return $this->context->createTopic(
             $this->config->createTransportQueueName($this->config->getRouterTopicName())