docs: add PHPDoc types

kenjis · kenjis · commit 5529415e2d1e · 2023-12-17T14:13:49.000+09:00
diff --git a/src/Config/Queue.php b/src/Config/Queue.php
@@ -7,6 +7,8 @@
 use CodeIgniter\Queue\Handlers\DatabaseHandler;
 use CodeIgniter\Queue\Handlers\PredisHandler;
 use CodeIgniter\Queue\Handlers\RedisHandler;
+use CodeIgniter\Queue\Interfaces\JobInterface;
+use CodeIgniter\Queue\Interfaces\QueueInterface;
 
 class Queue extends BaseConfig
 {
@@ -17,6 +19,8 @@ class Queue extends BaseConfig
 
     /**
      * Available handlers.
+     *
+     * @var array<string, class-string<QueueInterface>>
      */
     public array $handlers = [
         'database' => DatabaseHandler::class,
@@ -81,6 +85,8 @@ class Queue extends BaseConfig
 
     /**
      * Your jobs handlers.
+     *
+     * @var array<string, class-string<JobInterface>>
      */
     public array $jobHandlers = [];
 
@@ -95,6 +101,8 @@ public function __construct()
 
     /**
      * Resolve job class name.
+     *
+     * @return class-string<JobInterface>
      */
     public function resolveJobClass(string $name): string
     {
diff --git a/src/Config/Services.php b/src/Config/Services.php
@@ -15,7 +15,7 @@ public static function queue(?QueueConfig $config = null, $getShared = true): Qu
             return static::getSharedInstance('queue', $config);
         }
 
-        /** @var QueueConfig $config */
+        /** @var QueueConfig|null $config */
         $config ??= config('Queue');
 
         return (new Queue($config))->init();
diff --git a/src/Entities/QueueJob.php b/src/Entities/QueueJob.php
@@ -3,7 +3,18 @@
 namespace CodeIgniter\Queue\Entities;
 
 use CodeIgniter\Entity\Entity;
+use CodeIgniter\I18n\Time;
 
+/**
+ * @property int    $attempts
+ * @property Time   $available_at
+ * @property Time   $created_at
+ * @property int    $id
+ * @property array  $payload
+ * @property string $priority
+ * @property string $queue
+ * @property int    $status
+ */
 class QueueJob extends Entity
 {
     protected $dates = ['available_at', 'created_at'];

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ public static function queue(?QueueConfig $config = null, $getShared = true): Qu`
`15`	`15`	`return static::getSharedInstance('queue', $config);`
`16`	`16`	`}`
`17`	`17`
`18`		`- /** @var QueueConfig $config */`
	`18`	`+ /** @var QueueConfig\|null $config */`
`19`	`19`	`$config ??= config('Queue');`
`20`	`20`
`21`	`21`	`return (new Queue($config))->init();`