api/laravel/Queue/Capsule/Manager.yaml

218 lines
4.8 KiB
YAML
Raw Normal View History

2024-09-26 09:03:21 +00:00
name: Manager
class_comment: '# * @mixin \Illuminate\Queue\QueueManager
# * @mixin \Illuminate\Contracts\Queue\Queue'
dependencies:
- name: Container
type: class
source: Illuminate\Container\Container
- name: QueueManager
type: class
source: Illuminate\Queue\QueueManager
- name: QueueServiceProvider
type: class
source: Illuminate\Queue\QueueServiceProvider
- name: CapsuleManagerTrait
type: class
source: Illuminate\Support\Traits\CapsuleManagerTrait
- name: CapsuleManagerTrait
type: class
source: CapsuleManagerTrait
properties:
- name: manager
visibility: protected
comment: "# * @mixin \\Illuminate\\Queue\\QueueManager\n# * @mixin \\Illuminate\\\
Contracts\\Queue\\Queue\n# */\n# class Manager\n# {\n# use CapsuleManagerTrait;\n\
# \n# /**\n# * The queue manager instance.\n# *\n# * @var \\Illuminate\\Queue\\\
QueueManager"
methods:
- name: __construct
visibility: public
parameters:
- name: container
default: 'null'
comment: "# * @mixin \\Illuminate\\Queue\\QueueManager\n# * @mixin \\Illuminate\\\
Contracts\\Queue\\Queue\n# */\n# class Manager\n# {\n# use CapsuleManagerTrait;\n\
# \n# /**\n# * The queue manager instance.\n# *\n# * @var \\Illuminate\\Queue\\\
QueueManager\n# */\n# protected $manager;\n# \n# /**\n# * Create a new queue capsule\
\ manager.\n# *\n# * @param \\Illuminate\\Container\\Container|null $container\n\
# * @return void"
- name: setupDefaultConfiguration
visibility: protected
parameters: []
comment: '# * Setup the default queue configuration options.
# *
# * @return void'
- name: setupManager
visibility: protected
parameters: []
comment: '# * Build the queue manager instance.
# *
# * @return void'
- name: registerConnectors
visibility: protected
parameters: []
comment: '# * Register the default connectors that the component ships with.
# *
# * @return void'
- name: connection
visibility: public
parameters:
- name: connection
default: 'null'
comment: '# * Get a connection instance from the global manager.
# *
# * @param string|null $connection
# * @return \Illuminate\Contracts\Queue\Queue'
- name: push
visibility: public
parameters:
- name: job
- name: data
default: ''''''
- name: queue
default: 'null'
- name: connection
default: 'null'
comment: '# * Push a new job onto the queue.
# *
# * @param string $job
# * @param mixed $data
# * @param string|null $queue
# * @param string|null $connection
# * @return mixed'
- name: bulk
visibility: public
parameters:
- name: jobs
- name: data
default: ''''''
- name: queue
default: 'null'
- name: connection
default: 'null'
comment: '# * Push a new an array of jobs onto the queue.
# *
# * @param array $jobs
# * @param mixed $data
# * @param string|null $queue
# * @param string|null $connection
# * @return mixed'
- name: later
visibility: public
parameters:
- name: delay
- name: job
- name: data
default: ''''''
- name: queue
default: 'null'
- name: connection
default: 'null'
comment: '# * Push a new job onto the queue after (n) seconds.
# *
# * @param \DateTimeInterface|\DateInterval|int $delay
# * @param string $job
# * @param mixed $data
# * @param string|null $queue
# * @param string|null $connection
# * @return mixed'
- name: getConnection
visibility: public
parameters:
- name: name
default: 'null'
comment: '# * Get a registered connection instance.
# *
# * @param string|null $name
# * @return \Illuminate\Contracts\Queue\Queue'
- name: addConnection
visibility: public
parameters:
- name: config
- name: name
default: '''default'''
comment: '# * Register a connection with the manager.
# *
# * @param array $config
# * @param string $name
# * @return void'
- name: getQueueManager
visibility: public
parameters: []
comment: '# * Get the queue manager instance.
# *
# * @return \Illuminate\Queue\QueueManager'
- name: __call
visibility: public
parameters:
- name: method
- name: parameters
comment: '# * Pass dynamic instance methods to the manager.
# *
# * @param string $method
# * @param array $parameters
# * @return mixed'
- name: __callStatic
visibility: public
parameters:
- name: method
- name: parameters
comment: '# * Dynamically pass methods to the default connection.
# *
# * @param string $method
# * @param array $parameters
# * @return mixed'
traits:
- Illuminate\Container\Container
- Illuminate\Queue\QueueManager
- Illuminate\Queue\QueueServiceProvider
- Illuminate\Support\Traits\CapsuleManagerTrait
- CapsuleManagerTrait
interfaces: []