platform/api/laravel/Pipeline/Hub.yaml

103 lines
2.2 KiB
YAML
Raw Normal View History

2024-09-02 17:44:11 +00:00
name: Hub
class_comment: null
dependencies:
- name: Closure
type: class
source: Closure
- name: Container
type: class
source: Illuminate\Contracts\Container\Container
- name: HubContract
type: class
source: Illuminate\Contracts\Pipeline\Hub
properties:
- name: container
visibility: protected
comment: '# * The container implementation.
# *
# * @var \Illuminate\Contracts\Container\Container|null'
- name: pipelines
visibility: protected
comment: '# * All of the available pipelines.
# *
# * @var array'
methods:
- name: __construct
visibility: public
parameters:
- name: container
default: 'null'
comment: "# * The container implementation.\n# *\n# * @var \\Illuminate\\Contracts\\\
Container\\Container|null\n# */\n# protected $container;\n# \n# /**\n# * All of\
\ the available pipelines.\n# *\n# * @var array\n# */\n# protected $pipelines\
\ = [];\n# \n# /**\n# * Create a new Hub instance.\n# *\n# * @param \\Illuminate\\\
Contracts\\Container\\Container|null $container\n# * @return void"
- name: defaults
visibility: public
parameters:
- name: callback
comment: '# * Define the default named pipeline.
# *
# * @param \Closure $callback
# * @return void'
- name: pipeline
visibility: public
parameters:
- name: name
- name: callback
comment: '# * Define a new named pipeline.
# *
# * @param string $name
# * @param \Closure $callback
# * @return void'
- name: pipe
visibility: public
parameters:
- name: object
- name: pipeline
default: 'null'
comment: '# * Send an object through one of the available pipelines.
# *
# * @param mixed $object
# * @param string|null $pipeline
# * @return mixed'
- name: getContainer
visibility: public
parameters: []
comment: '# * Get the container instance used by the hub.
# *
# * @return \Illuminate\Contracts\Container\Container'
- name: setContainer
visibility: public
parameters:
- name: container
comment: '# * Set the container instance used by the hub.
# *
# * @param \Illuminate\Contracts\Container\Container $container
# * @return $this'
traits:
- Closure
- Illuminate\Contracts\Container\Container
interfaces:
- HubContract