TASK: Set types in interface methods

Author: daniellienert

Classes/Job/JobInterface.php

@@ -27,14 +27,14 @@ interface JobInterface
      *
      * @param QueueInterface $queue
      * @param Message $message The original message
-     * @return boolean TRUE if the job was executed successfully and the message should be finished
+     * @return bool TRUE if the job was executed successfully and the message should be finished
      */
-    public function execute(QueueInterface $queue, Message $message);
+    public function execute(QueueInterface $queue, Message $message): bool;
 
     /**
      * Get a readable label for the job
      *
      * @return string A label for the job
      */
-    public function getLabel();
+    public function getLabel(): string;
 }

Classes/Queue/FakeQueue.php

@@ -60,7 +60,7 @@ public function __construct($name, array $options = [])
     /**
      * @inheritdoc
      */
-    public function setUp()
+    public function setUp(): void
     {
         // The FakeQueue does not require any setup but we use it to verify the options
         if ($this->async && !method_exists(Scripts::class, 'executeCommandAsync')) {
@@ -71,15 +71,15 @@ public function setUp()
     /**
      * @inheritdoc
      */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
     /**
      * @inheritdoc
      */
-    public function submit($payload, array $options = [])
+    public function submit($payload, array $options = []): string
     {
         $messageId = Algorithms::generateUUID();
         $message = new Message($messageId, $payload);
@@ -98,47 +98,47 @@ public function submit($payload, array $options = [])
     /**
      * @inheritdoc
      */
-    public function waitAndTake($timeout = null)
+    public function waitAndTake(int $timeout = null): Message
     {
         throw new \BadMethodCallException('The FakeQueue does not support reserving of messages.' . chr(10) . 'It is not required to use a worker for this queue as messages are handled immediately upon submission.', 1468425275);
     }
 
     /**
      * @inheritdoc
      */
-    public function waitAndReserve($timeout = null)
+    public function waitAndReserve(int $timeout = null): Message
     {
         throw new \BadMethodCallException('The FakeQueue does not support reserving of messages.' . chr(10) . 'It is not required to use a worker for this queue as messages are handled immediately upon submission.', 1468425280);
     }
 
     /**
      * @inheritdoc
      */
-    public function release($messageId, array $options = [])
+    public function release(string $messageId, array $options = []): void
     {
         throw new \BadMethodCallException('The FakeQueue does not support releasing of failed messages.' . chr(10) . 'The "maximumNumberOfReleases" setting should be removed or set to 0 for this queue!', 1468425285);
     }
 
     /**
      * @inheritdoc
      */
-    public function abort($messageId)
+    public function abort(string $messageId): void
     {
         // The FakeQueue does not support message abortion
     }
 
     /**
      * @inheritdoc
      */
-    public function finish($messageId)
+    public function finish(string $messageId): bool
     {
         // The FakeQueue does not support message finishing
     }
 
     /**
      * @inheritdoc
      */
-    public function peek($limit = 1)
+    public function peek(int $limit = 1): array
     {
         return [];
     }
@@ -170,7 +170,7 @@ public function countFailed(): int
     /**
      * @inheritdoc
      */
-    public function flush()
+    public function flush(): void
     {
         // The FakeQueue does not support message flushing
     }

Classes/Queue/QueueInterface.php

@@ -21,14 +21,14 @@ interface QueueInterface
     /**
      * @return void
      */
-    public function setUp();
+    public function setUp(): void;
 
     /**
      * The unique name of this queue
      *
      * @return string
      */
-    public function getName();
+    public function getName(): string;
 
     /**
      * Submit a message to the queue
@@ -37,17 +37,17 @@ public function getName();
      * @param array $options Simple key/value array with options, supported options depend on the queue implementation
      * @return string The identifier of the message under which it was queued
      */
-    public function submit($payload, array $options = []);
+    public function submit($payload, array $options = []): string;
 
     /**
      * Wait for a message in the queue and remove the message from the queue for processing
      * If a non-null value was returned, the message was not queued. Otherwise a timeout
      * occurred and no message was available or received.
      *
-     * @param integer $timeout
+     * @param int $timeout
      * @return Message The received message or NULL if a timeout occurred
      */
-    public function waitAndTake($timeout = null);
+    public function waitAndTake(?int $timeout = null): ?Message;
 
     /**
      * Wait for a message in the queue and reserve the message for processing
@@ -57,10 +57,10 @@ public function waitAndTake($timeout = null);
      * If a non-null value was returned, the message was reserved. Otherwise a timeout
      * occurred and no message was available or received.
      *
-     * @param integer $timeout
+     * @param int $timeout
      * @return Message The received message or NULL if a timeout occurred
      */
-    public function waitAndReserve($timeout = null);
+    public function waitAndReserve(?int $timeout = null): ?Message;
 
     /**
      * Puts a reserved message back to the queue
@@ -69,15 +69,15 @@ public function waitAndReserve($timeout = null);
      * @param array $options Simple key/value array with options that can be interpreted by the concrete implementation (optional)
      * @return void
      */
-    public function release($messageId, array $options = []);
+    public function release(string $messageId, array $options = []): void;
 
     /**
      * Removes a message from the active queue and marks it failed (bury)
      *
      * @param string $messageId
      * @return void
      */
-    public function abort($messageId);
+    public function abort(string $messageId): void;
 
     /**
      * Mark a message as done
@@ -86,9 +86,9 @@ public function abort($messageId);
      * processed successfully.
      *
      * @param string $messageId
-     * @return boolean TRUE if the message could be removed
+     * @return bool TRUE if the message could be removed
      */
-    public function finish($messageId);
+    public function finish(string $messageId): bool;
 
     /**
      * Peek for messages
@@ -99,7 +99,7 @@ public function finish($messageId);
      * @param integer $limit
      * @return Message[] The messages up to the length of limit or an empty array if no messages are present currently
      */
-    public function peek($limit = 1);
+    public function peek(int $limit = 1): array;
 
     /**
      * Get a count of ready messages currently in the queue.
@@ -130,5 +130,5 @@ public function countFailed(): int;
      *
      * @return void
      */
-    public function flush();
+    public function flush(): void;
 }

Tests/Unit/Fixtures/TestJob.php

@@ -33,15 +33,14 @@ public function __construct($failNumberOfTimes = 0)
         $this->failNumberOfTimes = $failNumberOfTimes;
     }
 
-
     /**
      * Do nothing
      *
      * @param QueueInterface $queue
      * @param Message $message
-     * @return boolean
+     * @return bool
      */
-    public function execute(QueueInterface $queue, Message $message)
+    public function execute(QueueInterface $queue, Message $message): bool
     {
         if ($this->failNumberOfTimes > $message->getNumberOfReleases()) {
             return false;
@@ -54,7 +53,7 @@ public function execute(QueueInterface $queue, Message $message)
      *
      * @return string A label for the job
      */
-    public function getLabel()
+    public function getLabel(): string
     {
         return 'Test Job';
     }