api/laravel/Queue/Console/ClearCommand.yaml
2024-09-26 02:03:21 -07:00

92 lines
2.2 KiB
YAML

name: ClearCommand
class_comment: null
dependencies:
- name: Command
type: class
source: Illuminate\Console\Command
- name: ConfirmableTrait
type: class
source: Illuminate\Console\ConfirmableTrait
- name: ClearableQueue
type: class
source: Illuminate\Contracts\Queue\ClearableQueue
- name: Str
type: class
source: Illuminate\Support\Str
- name: ReflectionClass
type: class
source: ReflectionClass
- name: AsCommand
type: class
source: Symfony\Component\Console\Attribute\AsCommand
- name: InputArgument
type: class
source: Symfony\Component\Console\Input\InputArgument
- name: InputOption
type: class
source: Symfony\Component\Console\Input\InputOption
- name: ConfirmableTrait
type: class
source: ConfirmableTrait
properties:
- name: name
visibility: protected
comment: '# * The console command name.
# *
# * @var string'
- name: description
visibility: protected
comment: '# * The console command description.
# *
# * @var string'
methods:
- name: handle
visibility: public
parameters: []
comment: "# * The console command name.\n# *\n# * @var string\n# */\n# protected\
\ $name = 'queue:clear';\n# \n# /**\n# * The console command description.\n# *\n\
# * @var string\n# */\n# protected $description = 'Delete all of the jobs from\
\ the specified queue';\n# \n# /**\n# * Execute the console command.\n# *\n# *\
\ @return int|null"
- name: getQueue
visibility: protected
parameters:
- name: connection
comment: '# * Get the queue name to clear.
# *
# * @param string $connection
# * @return string'
- name: getArguments
visibility: protected
parameters: []
comment: '# * Get the console command arguments.
# *
# * @return array'
- name: getOptions
visibility: protected
parameters: []
comment: '# * Get the console command options.
# *
# * @return array'
traits:
- Illuminate\Console\Command
- Illuminate\Console\ConfirmableTrait
- Illuminate\Contracts\Queue\ClearableQueue
- Illuminate\Support\Str
- ReflectionClass
- Symfony\Component\Console\Attribute\AsCommand
- Symfony\Component\Console\Input\InputArgument
- Symfony\Component\Console\Input\InputOption
- ConfirmableTrait
interfaces: []