feat: update PHPStan lvl to 4

Author: SMillerDev

.github/workflows/php-test.yml

@@ -89,5 +89,5 @@ jobs:
         run: composer install
 
       - name: Run PHPStan
-        run: ./vendor/bin/phpstan analyse lib -l1
+        run: ./vendor/bin/phpstan analyse lib -l4
 

lib/FailureHandler.php

@@ -53,7 +53,7 @@ public static function createFromError($payload, Error $exception, ResqueWorker
 	/**
 	 * Return an instance of the backend for saving job failures.
 	 *
-	 * @return object Instance of backend object.
+	 * @return object|string Instance of backend object.
 	 */
 	public static function getBackend()
 	{

lib/Job/Factory.php

@@ -7,9 +7,9 @@
 class Factory implements FactoryInterface
 {
 	/**
-	 * @param $className
-	 * @param array $args
-	 * @param $queue
+	 * @param class-string<\Resque\Job\JobInterface> $className
+	 * @param array        							 $args
+	 * @param string       							 $queue
 	 * @return \Resque\Job\JobInterface
 	 * @throws \Resque\Exceptions\ResqueException
 	 */

lib/Job/JobInterface.php

@@ -2,6 +2,10 @@
 
 namespace Resque\Job;
 
+/**
+ * @property array $args
+ * @property string $queue
+ */
 interface JobInterface
 {
 	/**

lib/Job/Status.php

@@ -97,7 +97,8 @@ public function isTracking()
 	/**
 	 * Update the status indicator for the current job with a new status.
 	 *
-	 * @param int The status of the job (see constants in Resque\Job\Status)
+	 * @param int 	   $status The status of the job (see constants in Resque\Job\Status)
+	 * @param int|null $result The result of the job
 	 */
 	public function update($status, $result = null)
 	{

lib/JobHandler.php

@@ -25,7 +25,7 @@ class JobHandler
 	public $queue;
 
 	/**
-	 * @var \Resque\Worker\Resque Instance of the Resque worker running this job.
+	 * @var \Resque\Worker\ResqueWorker Instance of the Resque worker running this job.
 	 */
 	public $worker;
 
@@ -35,7 +35,7 @@ class JobHandler
 	public $payload;
 
 	/**
-	 * @var object|\Resque\Job\JobInterface Instance of the class performing work for this job.
+	 * @var object|\Resque\Job\JobInterface|null Instance of the class performing work for this job.
 	 */
 	private $instance;
 
@@ -59,12 +59,12 @@ public function __construct($queue, $payload)
 	/**
 	 * Create a new job and save it to the specified queue.
 	 *
-	 * @param string $queue The name of the queue to place the job in.
-	 * @param string $class The name of the class that contains the code to execute the job.
-	 * @param array $args Any optional arguments that should be passed when the job is executed.
-	 * @param boolean $monitor Set to true to be able to monitor the status of a job.
-	 * @param string $id Unique identifier for tracking the job. Generated if not supplied.
-	 * @param string $prefix The prefix needs to be set for the status key
+	 * @param string 	   $queue The name of the queue to place the job in.
+	 * @param class-string $class The name of the class that contains the code to execute the job.
+	 * @param array|null   $args Any optional arguments that should be passed when the job is executed.
+	 * @param boolean 	   $monitor Set to true to be able to monitor the status of a job.
+	 * @param string 	   $id Unique identifier for tracking the job. Generated if not supplied.
+	 * @param string 	   $prefix The prefix needs to be set for the status key
 	 *
 	 * @return string
 	 * @throws \InvalidArgumentException
@@ -187,8 +187,10 @@ public function getInstance()
 			return $this->instance;
 		}
 
-		$this->instance = $this->getJobFactory()->create($this->payload['class'], $this->getArguments(), $this->queue);
+		$this->instance = $this->getJobFactory()
+							   ->create($this->payload['class'], $this->getArguments(), $this->queue);
 		$this->instance->job = $this;
+
 		return $this->instance;
 	}
 
@@ -197,7 +199,7 @@ public function getInstance()
 	 * associated with the job with the supplied arguments.
 	 *
 	 * @return bool
-	 * @throws Resque\Exceptions\ResqueException When the job's class could not be found
+	 * @throws \Resque\Exceptions\ResqueException When the job's class could not be found
 	 * 											 or it does not contain a perform method.
 	 */
 	public function perform()
@@ -308,8 +310,8 @@ public function __toString()
 	}
 
 	/**
-	 * @param Resque\Job\FactoryInterface $jobFactory
-	 * @return Resque\JobHandler
+	 * @param \Resque\Job\FactoryInterface $jobFactory
+	 * @return \Resque\JobHandler
 	 */
 	public function setJobFactory(FactoryInterface $jobFactory)
 	{
@@ -319,7 +321,7 @@ public function setJobFactory(FactoryInterface $jobFactory)
 	}
 
 	/**
-	 * @return Resque\Job\FactoryInterface
+	 * @return \Resque\Job\FactoryInterface
 	 */
 	public function getJobFactory()
 	{

lib/Redis.php

@@ -14,6 +14,34 @@
  * @package		Resque/Redis
  * @author		Chris Boulton <[email protected]>
  * @license		http://www.opensource.org/licenses/mit-license.php
+ *
+ * @mixin Credis_Cluster
+ * @method string get(string $key)
+ * @method bool exists(string $key)
+ * @method array smembers(string $set)
+ * @method bool sismember(string $set, string $key)
+ * @method bool del(string $key)
+ * @method void set(string $key, mixed $value)
+ * @method bool expire(string $key, string $key2)
+ * @method bool ping(?string $value = null)
+ * @method bool incrby(string $key, int $increment)
+ * @method bool decrby(string $key, int $decrement)
+ * @method bool rpush(string $key, string ...$element)
+ * @method array blpop(string $key, int $timeout)
+ * @method array lpop(string $key, int $count = 1)
+ * @method array rpop(string $key, int $count = 1)
+ * @method int llen(string $key)
+ * @method array lrange(string $key, int $start, int $stop)
+ * @method int rpoplpush(string $source, string $destination)
+ * @method void zadd(string $key, int $score, string $member)
+ * @method int zcard(string $key)
+ * @method int sadd(string $key, string $member)
+ * @method int srem(string $key, string $member)
+ * @method int lrem(string $key, int $count, string $element)
+ * @method array keys(string $pattern)
+ * @method int zrem(string $key, string $member)
+ * @method array zrangebyscore(string $key, int $min, int $max, bool $scores)
+
  */
 class Redis
 {
@@ -120,7 +148,7 @@ public static function prefix($namespace)
 	}
 
 	/**
-	 * @param string|array $server A DSN or array
+	 * @param string|array|object $server A DSN or array
 	 * @param int $database A database number to select. However, if we find a valid database number in the DSN the
 	 *                      DSN-supplied value will be used instead and this parameter is ignored.
 	 * @param object $client Optional Credis_Cluster or Credis_Client instance instantiated by you

lib/Resque.php

@@ -19,7 +19,7 @@ class Resque
 	public const DEFAULT_INTERVAL = 5;
 
 	/**
-	 * @var Redis Instance of Resque\Redis that talks to redis.
+	 * @var Redis|null Instance of Resque\Redis that talks to redis.
 	 */
 	public static $redis = null;
 
@@ -89,7 +89,7 @@ public static function redis()
 	 *
 	 * Will close connection to Redis before forking.
 	 *
-	 * @return int Return vars as per pcntl_fork(). False if pcntl_fork is unavailable
+	 * @return int|false Return vars as per pcntl_fork(). False if pcntl_fork is unavailable
 	 */
 	public static function fork()
 	{
@@ -135,14 +135,14 @@ public static function push($queue, $item)
 	 * return it.
 	 *
 	 * @param string $queue The name of the queue to fetch an item from.
-	 * @return array Decoded item from the queue.
+	 * @return array|null Decoded item from the queue.
 	 */
 	public static function pop($queue)
 	{
 		$item = self::redis()->lpop('queue:' . $queue);
 
 		if (!$item) {
-			return;
+			return NULL;
 		}
 
 		return json_decode($item, true);
@@ -195,7 +195,7 @@ public static function blpop(array $queues, $timeout)
 		$item = self::redis()->blpop($list, (int)$timeout);
 
 		if (!$item) {
-			return;
+			return NULL;
 		}
 
 		/**

lib/Scheduler.php

@@ -193,7 +193,7 @@ private static function cleanupTimestamp($key, $timestamp)
 	 *
 	 * @param \DateTime|int $timestamp Instance of DateTime or UNIX timestamp.
 	 * @return int Timestamp
-	 * @throws Scheduler_InvalidTimestampException
+	 * @throws InvalidTimestampException
 	 */
 	private static function getTimestamp($timestamp)
 	{
@@ -218,8 +218,8 @@ private static function getTimestamp($timestamp)
 	 * that any jobs scheduled for the past when the worker wasn't running are
 	 * also queued up.
 	 *
-	 * @param \DateTime|int $timestamp Instance of DateTime or UNIX timestamp.
-	 *                                Defaults to now.
+	 * @param \DateTime|int $at Instance of DateTime or UNIX timestamp.
+	 *                          Defaults to now.
 	 * @return int|false UNIX timestamp, or false if nothing to run.
 	 */
 	public static function nextDelayedTimestamp($at = null)

lib/Worker/ResqueWorker.php

@@ -69,12 +69,12 @@ class ResqueWorker
 	private $id;
 
 	/**
-	 * @var \Resque\JobHandler Current job, if any, being processed by this worker.
+	 * @var \Resque\JobHandler|null Current job, if any, being processed by this worker.
 	 */
 	private $currentJob = null;
 
 	/**
-	 * @var int Process ID of child worker processes.
+	 * @var int|null Process ID of child worker processes.
 	 */
 	private $child = null;
 
@@ -145,7 +145,7 @@ public static function exists($workerId)
 	 * Given a worker ID, find it and return an instantiated worker class for it.
 	 *
 	 * @param string $workerId The ID of the worker.
-	 * @return \Resque\Worker\ResqueWorker Instance of the worker. False if the worker does not exist.
+	 * @return \Resque\Worker\ResqueWorker|false Instance of the worker. False if the worker does not exist.
 	 */
 	public static function find($workerId)
 	{
@@ -338,7 +338,7 @@ public function perform(JobHandler $job)
 	/**
 	 * @param  bool            $blocking
 	 * @param  int             $timeout
-	 * @return object|boolean               Instance of Resque\JobHandler if a job is found, false if not.
+	 * @return \Resque\JobHandler|boolean Instance of Resque\JobHandler if a job is found, false if not.
 	 */
 	public function reserve($blocking = false, $timeout = null)
 	{
@@ -349,7 +349,7 @@ public function reserve($blocking = false, $timeout = null)
 
 		$queues = $this->queues();
 		if (!is_array($queues)) {
-			return;
+			return false;
 		}
 
 		if ($blocking === true) {
@@ -423,7 +423,7 @@ private function startup()
 	 */
 	private function updateProcLine($status)
 	{
-		$processTitle  = static::$processPrefix . '-' . Resque::VERSION;
+		$processTitle  = self::$processPrefix . '-' . Resque::VERSION;
 		$processTitle .= ' (' . implode(',', $this->queues) . '): ' . $status;
 		if (function_exists('cli_set_process_title') && PHP_OS !== 'Darwin') {
 			cli_set_process_title($processTitle);
@@ -605,7 +605,7 @@ public function unregisterWorker()
 	/**
 	 * Tell Redis which job we're currently working on.
 	 *
-	 * @param object $job \Resque\JobHandler instance containing the job we're working on.
+	 * @param \Resque\JobHandler $job instance containing the job we're working on.
 	 */
 	public function workingOn(JobHandler $job)
 	{
@@ -645,7 +645,7 @@ public function __toString()
 	/**
 	 * Return an object describing the job this worker is currently working on.
 	 *
-	 * @return object Object with details of current job.
+	 * @return array<string, mixed> Object with details of current job.
 	 */
 	public function job()
 	{