Job statuses (#34)

src/DriverInterface.php

@@ -4,6 +4,8 @@
 
 namespace Yiisoft\Yii\Queue;
 
+use InvalidArgumentException;
+use Yiisoft\Yii\Queue\Enum\JobStatus;
 use Yiisoft\Yii\Queue\Jobs\DelayableJobInterface;
 use Yiisoft\Yii\Queue\Jobs\JobInterface;
 use Yiisoft\Yii\Queue\Jobs\PrioritisedJobInterface;
@@ -23,9 +25,11 @@ public function nextMessage(): ?MessageInterface;
      *
      * @param string $id of a job message
      *
-     * @return int status code
+     * @return JobStatus
+     *
+     * @throws InvalidArgumentException when there is no such id in the driver
      */
-    public function status(string $id): int;
+    public function status(string $id): JobStatus;
 
     /**
      * Pushing a job to the queue

src/Enum/JobStatus.php

@@ -0,0 +1,60 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Yii\Queue\Enum;
+
+use InvalidArgumentException;
+
+class JobStatus
+{
+    public const WAITING = 1;
+    public const RESERVED = 2;
+    public const DONE = 3;
+
+    protected int $status;
+
+    protected function __construct(int $status)
+    {
+        if (!in_array($status, $this->available(), true)) {
+            throw new InvalidArgumentException('Invalid status provided');
+        }
+
+        $this->status = $status;
+    }
+
+    protected function available(): array
+    {
+        return [self::WAITING, self::RESERVED, self::DONE];
+    }
+
+    public static function waiting(): self
+    {
+        return new static(self::WAITING);
+    }
+
+    public static function reserved(): self
+    {
+        return new static(self::RESERVED);
+    }
+
+    public static function done(): self
+    {
+        return new static(self::DONE);
+    }
+
+    public function isWaiting(): bool
+    {
+        return $this->status === self::WAITING;
+    }
+
+    public function isReserved(): bool
+    {
+        return $this->status === self::RESERVED;
+    }
+
+    public function isDone(): bool
+    {
+        return $this->status === self::DONE;
+    }
+}

src/Queue.php

@@ -2,9 +2,11 @@
 
 namespace Yiisoft\Yii\Queue;
 
+use InvalidArgumentException;
 use Psr\EventDispatcher\EventDispatcherInterface;
 use Yiisoft\EventDispatcher\Provider\Provider;
 use Yiisoft\Yii\Queue\Cli\LoopInterface;
+use Yiisoft\Yii\Queue\Enum\JobStatus;
 use Yiisoft\Yii\Queue\Events\AfterPush;
 use Yiisoft\Yii\Queue\Events\BeforePush;
 use Yiisoft\Yii\Queue\Events\JobFailure;
@@ -109,4 +111,16 @@ public function listen(): void
 
         $this->driver->subscribe($handler);
     }
+
+    /**
+     * @param string $id A job id
+     *
+     * @return JobStatus
+     *
+     * @throws InvalidArgumentException when there is no such id in the driver
+     */
+    public function status(string $id): JobStatus
+    {
+        return $this->driver->status($id);
+    }
 }