platform/api/laravel/Contracts/Bus/Dispatcher.yaml

97 lines
1.7 KiB
YAML
Raw Normal View History

2024-09-02 17:44:11 +00:00
name: Dispatcher
class_comment: null
dependencies: []
properties: []
methods:
- name: dispatch
visibility: public
parameters:
- name: command
comment: '# * Dispatch a command to its appropriate handler.
# *
# * @param mixed $command
# * @return mixed'
- name: dispatchSync
visibility: public
parameters:
- name: command
- name: handler
default: 'null'
comment: '# * Dispatch a command to its appropriate handler in the current process.
# *
# * Queueable jobs will be dispatched to the "sync" queue.
# *
# * @param mixed $command
# * @param mixed $handler
# * @return mixed'
- name: dispatchNow
visibility: public
parameters:
- name: command
- name: handler
default: 'null'
comment: '# * Dispatch a command to its appropriate handler in the current process.
# *
# * @param mixed $command
# * @param mixed $handler
# * @return mixed'
- name: hasCommandHandler
visibility: public
parameters:
- name: command
comment: '# * Determine if the given command has a handler.
# *
# * @param mixed $command
# * @return bool'
- name: getCommandHandler
visibility: public
parameters:
- name: command
comment: '# * Retrieve the handler for a command.
# *
# * @param mixed $command
# * @return bool|mixed'
- name: pipeThrough
visibility: public
parameters:
- name: pipes
comment: '# * Set the pipes commands should be piped through before dispatching.
# *
# * @param array $pipes
# * @return $this'
- name: map
visibility: public
parameters:
- name: map
comment: '# * Map a command to a handler.
# *
# * @param array $map
# * @return $this'
traits: []
interfaces: []