Skip to content

Commit a714306

Browse files
authored
Improve docblocks for nullable parameters (#1601)
1 parent a5c29df commit a714306

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

src/Contracts/JobRepository.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -31,39 +31,39 @@ public function totalFailed();
3131
/**
3232
* Get a chunk of recent jobs.
3333
*
34-
* @param string $afterIndex
34+
* @param string|null $afterIndex
3535
* @return \Illuminate\Support\Collection
3636
*/
3737
public function getRecent($afterIndex = null);
3838

3939
/**
4040
* Get a chunk of failed jobs.
4141
*
42-
* @param string $afterIndex
42+
* @param string|null $afterIndex
4343
* @return \Illuminate\Support\Collection
4444
*/
4545
public function getFailed($afterIndex = null);
4646

4747
/**
4848
* Get a chunk of pending jobs.
4949
*
50-
* @param string $afterIndex
50+
* @param string|null $afterIndex
5151
* @return \Illuminate\Support\Collection
5252
*/
5353
public function getPending($afterIndex = null);
5454

5555
/**
5656
* Get a chunk of completed jobs.
5757
*
58-
* @param string $afterIndex
58+
* @param string|null $afterIndex
5959
* @return \Illuminate\Support\Collection
6060
*/
6161
public function getCompleted($afterIndex = null);
6262

6363
/**
6464
* Get a chunk of silenced jobs.
6565
*
66-
* @param string $afterIndex
66+
* @param string|null $afterIndex
6767
* @return \Illuminate\Support\Collection
6868
*/
6969
public function getSilenced($afterIndex = null);

src/Horizon.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -202,7 +202,7 @@ public static function routeMailNotificationsTo($email)
202202
* Specify the webhook URL and channel to which Slack notifications should be routed.
203203
*
204204
* @param string $url
205-
* @param string $channel
205+
* @param string|null $channel
206206
* @return static
207207
*/
208208
public static function routeSlackNotificationsTo($url, $channel = null)

src/MasterSupervisor.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ class MasterSupervisor implements Pausable, Restartable, Terminable
6666
/**
6767
* Create a new master supervisor instance.
6868
*
69-
* @param string $environment
69+
* @param string|null $environment
7070
* @return void
7171
*/
7272
public function __construct(?string $environment = null)

src/RedisQueue.php

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ function ($payload, $queue) use ($job) {
5959
* Push a raw payload onto the queue.
6060
*
6161
* @param string $payload
62-
* @param string $queue
62+
* @param string|null $queue
6363
* @param array $options
6464
* @return mixed
6565
*/
@@ -99,7 +99,7 @@ protected function createPayloadArray($job, $queue, $data = '')
9999
* @param \DateTimeInterface|\DateInterval|int $delay
100100
* @param string $job
101101
* @param mixed $data
102-
* @param string $queue
102+
* @param string|null $queue
103103
* @return mixed
104104
*/
105105
#[\Override]
@@ -129,7 +129,7 @@ function ($payload, $queue, $delay) {
129129
/**
130130
* Pop the next job off of the queue.
131131
*
132-
* @param string $queue
132+
* @param string|null $queue
133133
* @param int $index
134134
* @return \Illuminate\Contracts\Queue\Job|null
135135
*/

src/SupervisorOptions.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ class SupervisorOptions
177177
*
178178
* @param string $name
179179
* @param string $connection
180-
* @param string $queue
180+
* @param string|null $queue
181181
* @param string $workersName
182182
* @param string $balance
183183
* @param int $backoff

0 commit comments

Comments
 (0)