api/laravel/Http/Client/Pool.yaml

96 lines
2.1 KiB
YAML
Raw Permalink Normal View History

2024-09-26 09:03:21 +00:00
name: Pool
class_comment: '# * @mixin \Illuminate\Http\Client\Factory'
dependencies:
- name: Utils
type: class
source: GuzzleHttp\Utils
properties:
- name: factory
visibility: protected
comment: '# * @mixin \Illuminate\Http\Client\Factory
# */
# class Pool
# {
# /**
# * The factory instance.
# *
# * @var \Illuminate\Http\Client\Factory'
- name: handler
visibility: protected
comment: '# * The handler function for the Guzzle client.
# *
# * @var callable'
- name: pool
visibility: protected
comment: '# * The pool of requests.
# *
# * @var array'
methods:
- name: __construct
visibility: public
parameters:
- name: factory
default: 'null'
comment: "# * @mixin \\Illuminate\\Http\\Client\\Factory\n# */\n# class Pool\n#\
\ {\n# /**\n# * The factory instance.\n# *\n# * @var \\Illuminate\\Http\\Client\\\
Factory\n# */\n# protected $factory;\n# \n# /**\n# * The handler function for\
\ the Guzzle client.\n# *\n# * @var callable\n# */\n# protected $handler;\n# \n\
# /**\n# * The pool of requests.\n# *\n# * @var array\n# */\n# protected $pool\
\ = [];\n# \n# /**\n# * Create a new requests pool.\n# *\n# * @param \\Illuminate\\\
Http\\Client\\Factory|null $factory\n# * @return void"
- name: as
visibility: public
parameters:
- name: key
comment: '# * Add a request to the pool with a key.
# *
# * @param string $key
# * @return \Illuminate\Http\Client\PendingRequest'
- name: asyncRequest
visibility: protected
parameters: []
comment: '# * Retrieve a new async pending request.
# *
# * @return \Illuminate\Http\Client\PendingRequest'
- name: getRequests
visibility: public
parameters: []
comment: '# * Retrieve the requests in the pool.
# *
# * @return array'
- name: __call
visibility: public
parameters:
- name: method
- name: parameters
comment: '# * Add a request to the pool with a numeric index.
# *
# * @param string $method
# * @param array $parameters
# * @return \Illuminate\Http\Client\PendingRequest|\GuzzleHttp\Promise\Promise'
traits:
- GuzzleHttp\Utils
interfaces: []