api/laravel/Queue/Failed/FailedJobProviderInterface.yaml

80 lines
1.3 KiB
YAML
Raw Permalink Normal View History

2024-09-26 09:03:21 +00:00
name: FailedJobProviderInterface
class_comment: null
dependencies: []
properties: []
methods:
- name: log
visibility: public
parameters:
- name: connection
- name: queue
- name: payload
- name: exception
comment: '# * @method array ids(string $queue = null)
# */
# interface FailedJobProviderInterface
# {
# /**
# * Log a failed job into storage.
# *
# * @param string $connection
# * @param string $queue
# * @param string $payload
# * @param \Throwable $exception
# * @return string|int|null'
- name: all
visibility: public
parameters: []
comment: '# * Get a list of all of the failed jobs.
# *
# * @return array'
- name: find
visibility: public
parameters:
- name: id
comment: '# * Get a single failed job.
# *
# * @param mixed $id
# * @return object|null'
- name: forget
visibility: public
parameters:
- name: id
comment: '# * Delete a single failed job from storage.
# *
# * @param mixed $id
# * @return bool'
- name: flush
visibility: public
parameters:
- name: hours
default: 'null'
comment: '# * Flush all of the failed jobs from storage.
# *
# * @param int|null $hours
# * @return void'
traits: []
interfaces: []