169 lines
2.9 KiB
YAML
169 lines
2.9 KiB
YAML
|
name: Queue
|
||
|
|
class_comment: null
|
||
|
|
dependencies: []
|
||
|
|
properties: []
|
||
|
|
methods:
|
||
|
|
- name: size
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Get the size of the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @return int'
|
||
|
|
- name: push
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: job
|
||
|
|
- name: data
|
||
|
|
default: ''''''
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Push a new job onto the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string|object $job
|
||
|
|
|
||
|
|
# * @param mixed $data
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: pushOn
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: queue
|
||
|
|
- name: job
|
||
|
|
- name: data
|
||
|
|
default: ''''''
|
||
|
|
comment: '# * Push a new job onto the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $queue
|
||
|
|
|
||
|
|
# * @param string|object $job
|
||
|
|
|
||
|
|
# * @param mixed $data
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: pushRaw
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: payload
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
- name: options
|
||
|
|
default: '[]'
|
||
|
|
comment: '# * Push a raw payload onto the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $payload
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @param array $options
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: later
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: delay
|
||
|
|
- name: job
|
||
|
|
- name: data
|
||
|
|
default: ''''''
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Push a new job onto the queue after (n) seconds.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param \DateTimeInterface|\DateInterval|int $delay
|
||
|
|
|
||
|
|
# * @param string|object $job
|
||
|
|
|
||
|
|
# * @param mixed $data
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: laterOn
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: queue
|
||
|
|
- name: delay
|
||
|
|
- name: job
|
||
|
|
- name: data
|
||
|
|
default: ''''''
|
||
|
|
comment: '# * Push a new job onto a specific queue after (n) seconds.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $queue
|
||
|
|
|
||
|
|
# * @param \DateTimeInterface|\DateInterval|int $delay
|
||
|
|
|
||
|
|
# * @param string|object $job
|
||
|
|
|
||
|
|
# * @param mixed $data
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: bulk
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: jobs
|
||
|
|
- name: data
|
||
|
|
default: ''''''
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Push an array of jobs onto the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param array $jobs
|
||
|
|
|
||
|
|
# * @param mixed $data
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @return mixed'
|
||
|
|
- name: pop
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: queue
|
||
|
|
default: 'null'
|
||
|
|
comment: '# * Pop the next job off of the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string|null $queue
|
||
|
|
|
||
|
|
# * @return \Illuminate\Contracts\Queue\Job|null'
|
||
|
|
- name: getConnectionName
|
||
|
|
visibility: public
|
||
|
|
parameters: []
|
||
|
|
comment: '# * Get the connection name for the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @return string'
|
||
|
|
- name: setConnectionName
|
||
|
|
visibility: public
|
||
|
|
parameters:
|
||
|
|
- name: name
|
||
|
|
comment: '# * Set the connection name for the queue.
|
||
|
|
|
||
|
|
# *
|
||
|
|
|
||
|
|
# * @param string $name
|
||
|
|
|
||
|
|
# * @return $this'
|
||
|
|
traits: []
|
||
|
|
interfaces: []
|