api/laravel/Queue/Jobs/RedisJob.yaml
2024-09-26 02:03:21 -07:00

125 lines
2.9 KiB
YAML

name: RedisJob
class_comment: null
dependencies:
- name: Container
type: class
source: Illuminate\Container\Container
- name: JobContract
type: class
source: Illuminate\Contracts\Queue\Job
- name: RedisQueue
type: class
source: Illuminate\Queue\RedisQueue
properties:
- name: redis
visibility: protected
comment: '# * The Redis queue instance.
# *
# * @var \Illuminate\Queue\RedisQueue'
- name: job
visibility: protected
comment: '# * The Redis raw job payload.
# *
# * @var string'
- name: decoded
visibility: protected
comment: '# * The JSON decoded version of "$job".
# *
# * @var array'
- name: reserved
visibility: protected
comment: '# * The Redis job payload inside the reserved queue.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: container
- name: redis
- name: job
- name: reserved
- name: connectionName
- name: queue
comment: "# * The Redis queue instance.\n# *\n# * @var \\Illuminate\\Queue\\RedisQueue\n\
# */\n# protected $redis;\n# \n# /**\n# * The Redis raw job payload.\n# *\n# *\
\ @var string\n# */\n# protected $job;\n# \n# /**\n# * The JSON decoded version\
\ of \"$job\".\n# *\n# * @var array\n# */\n# protected $decoded;\n# \n# /**\n\
# * The Redis job payload inside the reserved queue.\n# *\n# * @var string\n#\
\ */\n# protected $reserved;\n# \n# /**\n# * Create a new job instance.\n# *\n\
# * @param \\Illuminate\\Container\\Container $container\n# * @param \\Illuminate\\\
Queue\\RedisQueue $redis\n# * @param string $job\n# * @param string $reserved\n\
# * @param string $connectionName\n# * @param string $queue\n# * @return void"
- name: getRawBody
visibility: public
parameters: []
comment: '# * Get the raw body string for the job.
# *
# * @return string'
- name: delete
visibility: public
parameters: []
comment: '# * Delete the job from the queue.
# *
# * @return void'
- name: release
visibility: public
parameters:
- name: delay
default: '0'
comment: '# * Release the job back into the queue after (n) seconds.
# *
# * @param int $delay
# * @return void'
- name: attempts
visibility: public
parameters: []
comment: '# * Get the number of times the job has been attempted.
# *
# * @return int'
- name: getJobId
visibility: public
parameters: []
comment: '# * Get the job identifier.
# *
# * @return string|null'
- name: getRedisQueue
visibility: public
parameters: []
comment: '# * Get the underlying Redis factory implementation.
# *
# * @return \Illuminate\Queue\RedisQueue'
- name: getReservedJob
visibility: public
parameters: []
comment: '# * Get the underlying reserved Redis job.
# *
# * @return string'
traits:
- Illuminate\Container\Container
- Illuminate\Queue\RedisQueue
interfaces:
- JobContract