platform/api/laravel/Queue/Jobs/DatabaseJob.yaml
2024-09-02 10:44:11 -07:00

100 lines
2.2 KiB
YAML

name: DatabaseJob
class_comment: null
dependencies:
- name: Container
type: class
source: Illuminate\Container\Container
- name: JobContract
type: class
source: Illuminate\Contracts\Queue\Job
- name: DatabaseQueue
type: class
source: Illuminate\Queue\DatabaseQueue
properties:
- name: database
visibility: protected
comment: '# * The database queue instance.
# *
# * @var \Illuminate\Queue\DatabaseQueue'
- name: job
visibility: protected
comment: '# * The database job payload.
# *
# * @var \stdClass'
methods:
- name: __construct
visibility: public
parameters:
- name: container
- name: database
- name: job
- name: connectionName
- name: queue
comment: "# * The database queue instance.\n# *\n# * @var \\Illuminate\\Queue\\\
DatabaseQueue\n# */\n# protected $database;\n# \n# /**\n# * The database job payload.\n\
# *\n# * @var \\stdClass\n# */\n# protected $job;\n# \n# /**\n# * Create a new\
\ job instance.\n# *\n# * @param \\Illuminate\\Container\\Container $container\n\
# * @param \\Illuminate\\Queue\\DatabaseQueue $database\n# * @param \\stdClass\
\ $job\n# * @param string $connectionName\n# * @param string $queue\n# *\
\ @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: delete
visibility: public
parameters: []
comment: '# * Delete the job from the queue.
# *
# * @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'
- name: getRawBody
visibility: public
parameters: []
comment: '# * Get the raw body string for the job.
# *
# * @return string'
- name: getJobRecord
visibility: public
parameters: []
comment: '# * Get the database job record.
# *
# * @return \Illuminate\Queue\Jobs\DatabaseJobRecord'
traits:
- Illuminate\Container\Container
- Illuminate\Queue\DatabaseQueue
interfaces:
- JobContract