Typehint methods and properties of a Job

[bert-w]

Currently, a Laravel Job is as barebones as it gets since none of the methods or properties on the job are required. I think you can even use public function __invoke() instead of public function handle() which is the only condition that exists.

The issue here is that a lot of properties are not typehinted in the IDE since there is nothing documented for them inside the code. I'd like to propose a docblock typehint for these since it makes working with these functionalities much easier. All these properties are tested at runtime using method_exists($job, 'someMethod') or $job->someProp ?? 0 and do not seem to be in any trait or contract/interface:

/**
 * @method \DateTimeInterface|mixed backoff()
 * @method \Illuminate\Bus\Batch|null batch()
 * @method string displayName()
 * @method void failed(\Throwable $e)
 * @method array middleware()
 * @method \DateTimeInterface|mixed retryUntil()
 * @method bool shouldFailOnTimeout()
 * @method int uniqueFor()
 * @method string uniqueId()
 * @method \Illuminate\Cache\Repository uniqueVia()
 * @property \DateTimeInterface|mixed $backoff
 * @property \DateTimeInterface|mixed $retryUntil
 * @property int|null $uniqueFor
 * @property string|null $uniqueId
 */
interface Job
{
}

Sadly, the \Illuminate\Contracts\Queue\Job interface is already in use, so I am looking for an alternative. If anyone has a better idea on how to provide support for this, please post below.