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

85 lines
1.8 KiB
YAML

name: SyncJob
class_comment: null
dependencies:
- name: Container
type: class
source: Illuminate\Container\Container
- name: JobContract
type: class
source: Illuminate\Contracts\Queue\Job
properties:
- name: job
visibility: protected
comment: '# * The class name of the job.
# *
# * @var string'
- name: payload
visibility: protected
comment: '# * The queue message data.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: container
- name: payload
- name: connectionName
- name: queue
comment: "# * The class name of the job.\n# *\n# * @var string\n# */\n# protected\
\ $job;\n# \n# /**\n# * The queue message data.\n# *\n# * @var string\n# */\n\
# protected $payload;\n# \n# /**\n# * Create a new job instance.\n# *\n# * @param\
\ \\Illuminate\\Container\\Container $container\n# * @param string $payload\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: 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: getQueue
visibility: public
parameters: []
comment: '# * Get the name of the queue the job belongs to.
# *
# * @return string'
traits:
- Illuminate\Container\Container
interfaces:
- JobContract