queue/src/Job.php at e02b3572e5915cdd0fb4cd261c3a091105e22a00 · doppar/queue · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
<?php

namespace Doppar\Queue;

use Doppar\Queue\Contracts\JobInterface;

abstract class Job implements JobInterface
{
    /**
     * The number of times the job may be attempted.
     *
     * @var int
     */
    public $tries = 1;

    /**
     * The number of seconds to wait before retrying the job.
     *
     * @var int
     */
    public $retryAfter = 60;

    /**
     * The name of the queue the job should be sent to.
     *
     * @var string
     */
    public $queueName = 'default';

    /**
     * The number of seconds before the job should be made available.
     *
     * @var int
     */
    public $jobDelay = 0;

    /**
     * The job identifier.
     *
     * @var string|null
     */
    protected $jobId;

    /**
     * The number of times this job has been attempted.
     *
     * @var int
     */
    public $attempts = 0;

    /**
     * Get the number of times the job may be attempted.
     *
     * @return int
     */
    public function tries(): int
    {
        return $this->tries;
    }

    /**
     * Get the number of seconds before retrying.
     *
     * @return int
     */
    public function retryAfter(): int
    {
        return $this->retryAfter;
    }

    /**
     * Handle a job failure.
     *
     * @param \Throwable $exception
     * @return void
     */
    public function failed(\Throwable $exception): void
    {
        // Override in child classes if needed
    }

    /**
     * Get the queue name.
     *
     * @return string
     */
    public function queue(): string
    {
        return $this->queueName;
    }

    /**
     * Get the job delay.
     *
     * @return int
     */
    public function delay(): int
    {
        return $this->jobDelay;
    }

    /**
     * Get the job identifier.
     *
     * @return string|null
     */
    public function getJobId(): ?string
    {
        return $this->jobId;
    }

    /**
     * Set the job identifier.
     *
     * @param string $id
     * @return void
     */
    public function setJobId(string $id): void
    {
        $this->jobId = $id;
    }

    /**
     * Set the queue name.
     *
     * @param string $queue
     * @return $this
     */
    public function onQueue(string $queue): self
    {
        $this->queueName = $queue;

        return $this;
    }

    /**
     * Set the job delay.
     *
     * @param int $delay
     * @return $this
     */
    public function delayFor(int $delay): self
    {
        $this->jobDelay = $delay;

        return $this;
    }
}