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

163 lines
3.4 KiB
YAML

name: DatabaseFailedJobProvider
class_comment: null
dependencies:
- name: DateTimeInterface
type: class
source: DateTimeInterface
- name: ConnectionResolverInterface
type: class
source: Illuminate\Database\ConnectionResolverInterface
- name: Date
type: class
source: Illuminate\Support\Facades\Date
properties:
- name: resolver
visibility: protected
comment: '# * The connection resolver implementation.
# *
# * @var \Illuminate\Database\ConnectionResolverInterface'
- name: database
visibility: protected
comment: '# * The database connection name.
# *
# * @var string'
- name: table
visibility: protected
comment: '# * The database table.
# *
# * @var string'
methods:
- name: __construct
visibility: public
parameters:
- name: resolver
- name: database
- name: table
comment: "# * The connection resolver implementation.\n# *\n# * @var \\Illuminate\\\
Database\\ConnectionResolverInterface\n# */\n# protected $resolver;\n# \n# /**\n\
# * The database connection name.\n# *\n# * @var string\n# */\n# protected $database;\n\
# \n# /**\n# * The database table.\n# *\n# * @var string\n# */\n# protected $table;\n\
# \n# /**\n# * Create a new database failed job provider.\n# *\n# * @param \\\
Illuminate\\Database\\ConnectionResolverInterface $resolver\n# * @param string\
\ $database\n# * @param string $table\n# * @return void"
- name: log
visibility: public
parameters:
- name: connection
- name: queue
- name: payload
- name: exception
comment: '# * Log a failed job into storage.
# *
# * @param string $connection
# * @param string $queue
# * @param string $payload
# * @param \Throwable $exception
# * @return int|null'
- name: ids
visibility: public
parameters:
- name: queue
default: 'null'
comment: '# * Get the IDs of all of the failed jobs.
# *
# * @param string|null $queue
# * @return array'
- 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'
- name: prune
visibility: public
parameters:
- name: before
comment: '# * Prune all of the entries older than the given date.
# *
# * @param \DateTimeInterface $before
# * @return int'
- name: count
visibility: public
parameters:
- name: connection
default: 'null'
- name: queue
default: 'null'
comment: '# * Count the failed jobs.
# *
# * @param string|null $connection
# * @param string|null $queue
# * @return int'
- name: getTable
visibility: protected
parameters: []
comment: '# * Get a new query builder instance for the table.
# *
# * @return \Illuminate\Database\Query\Builder'
traits:
- DateTimeInterface
- Illuminate\Database\ConnectionResolverInterface
- Illuminate\Support\Facades\Date
interfaces:
- CountableFailedJobProvider