api/laravel/Support/Facades/Http.yaml
2024-09-26 02:03:21 -07:00

504 lines
17 KiB
YAML

name: Http
class_comment: '# * @method static \Illuminate\Http\Client\Factory globalMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalRequestMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalResponseMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalOptions(\Closure|array
$options)
# * @method static \GuzzleHttp\Promise\PromiseInterface response(array|string|null
$body = null, int $status = 200, array $headers = [])
# * @method static \Illuminate\Http\Client\ResponseSequence sequence(array $responses
= [])
# * @method static \Illuminate\Http\Client\Factory allowStrayRequests()
# * @method static void recordRequestResponsePair(\Illuminate\Http\Client\Request
$request, \Illuminate\Http\Client\Response $response)
# * @method static void assertSent(callable $callback)
# * @method static void assertSentInOrder(array $callbacks)
# * @method static void assertNotSent(callable $callback)
# * @method static void assertNothingSent()
# * @method static void assertSentCount(int $count)
# * @method static void assertSequencesAreEmpty()
# * @method static \Illuminate\Support\Collection recorded(callable $callback =
null)
# * @method static \Illuminate\Http\Client\PendingRequest createPendingRequest()
# * @method static \Illuminate\Contracts\Events\Dispatcher|null getDispatcher()
# * @method static array getGlobalMiddleware()
# * @method static void macro(string $name, object|callable $macro, object|callable
$macro = null)
# * @method static void mixin(object $mixin, bool $replace = true)
# * @method static bool hasMacro(string $name)
# * @method static void flushMacros()
# * @method static mixed macroCall(string $method, array $parameters)
# * @method static \Illuminate\Http\Client\PendingRequest baseUrl(string $url)
# * @method static \Illuminate\Http\Client\PendingRequest withBody(\Psr\Http\Message\StreamInterface|string
$content, string $contentType = ''application/json'')
# * @method static \Illuminate\Http\Client\PendingRequest asJson()
# * @method static \Illuminate\Http\Client\PendingRequest asForm()
# * @method static \Illuminate\Http\Client\PendingRequest attach(string|array $name,
string|resource $contents = '''', string|null $filename = null, array $headers =
[])
# * @method static \Illuminate\Http\Client\PendingRequest asMultipart()
# * @method static \Illuminate\Http\Client\PendingRequest bodyFormat(string $format)
# * @method static \Illuminate\Http\Client\PendingRequest withQueryParameters(array
$parameters)
# * @method static \Illuminate\Http\Client\PendingRequest contentType(string $contentType)
# * @method static \Illuminate\Http\Client\PendingRequest acceptJson()
# * @method static \Illuminate\Http\Client\PendingRequest accept(string $contentType)
# * @method static \Illuminate\Http\Client\PendingRequest withHeaders(array $headers)
# * @method static \Illuminate\Http\Client\PendingRequest withHeader(string $name,
mixed $value)
# * @method static \Illuminate\Http\Client\PendingRequest replaceHeaders(array $headers)
# * @method static \Illuminate\Http\Client\PendingRequest withBasicAuth(string $username,
string $password)
# * @method static \Illuminate\Http\Client\PendingRequest withDigestAuth(string
$username, string $password)
# * @method static \Illuminate\Http\Client\PendingRequest withToken(string $token,
string $type = ''Bearer'')
# * @method static \Illuminate\Http\Client\PendingRequest withUserAgent(string|bool
$userAgent)
# * @method static \Illuminate\Http\Client\PendingRequest withUrlParameters(array
$parameters = [])
# * @method static \Illuminate\Http\Client\PendingRequest withCookies(array $cookies,
string $domain)
# * @method static \Illuminate\Http\Client\PendingRequest maxRedirects(int $max)
# * @method static \Illuminate\Http\Client\PendingRequest withoutRedirecting()
# * @method static \Illuminate\Http\Client\PendingRequest withoutVerifying()
# * @method static \Illuminate\Http\Client\PendingRequest sink(string|resource $to)
# * @method static \Illuminate\Http\Client\PendingRequest timeout(int $seconds)
# * @method static \Illuminate\Http\Client\PendingRequest connectTimeout(int $seconds)
# * @method static \Illuminate\Http\Client\PendingRequest retry(array|int $times,
\Closure|int $sleepMilliseconds = 0, callable|null $when = null, bool $throw = true)
# * @method static \Illuminate\Http\Client\PendingRequest withOptions(array $options)
# * @method static \Illuminate\Http\Client\PendingRequest withMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest withRequestMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest withResponseMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest beforeSending(callable
$callback)
# * @method static \Illuminate\Http\Client\PendingRequest throw(callable|null $callback
= null)
# * @method static \Illuminate\Http\Client\PendingRequest throwIf(callable|bool
$condition)
# * @method static \Illuminate\Http\Client\PendingRequest throwUnless(bool $condition)
# * @method static \Illuminate\Http\Client\PendingRequest dump()
# * @method static \Illuminate\Http\Client\PendingRequest dd()
# * @method static \Illuminate\Http\Client\Response get(string $url, array|string|null
$query = null)
# * @method static \Illuminate\Http\Client\Response head(string $url, array|string|null
$query = null)
# * @method static \Illuminate\Http\Client\Response post(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response patch(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response put(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response delete(string $url, array $data
= [])
# * @method static array pool(callable $callback)
# * @method static \Illuminate\Http\Client\Response send(string $method, string
$url, array $options = [])
# * @method static \GuzzleHttp\Client buildClient()
# * @method static \GuzzleHttp\Client createClient(\GuzzleHttp\HandlerStack $handlerStack)
# * @method static \GuzzleHttp\HandlerStack buildHandlerStack()
# * @method static \GuzzleHttp\HandlerStack pushHandlers(\GuzzleHttp\HandlerStack
$handlerStack)
# * @method static \Closure buildBeforeSendingHandler()
# * @method static \Closure buildRecorderHandler()
# * @method static \Closure buildStubHandler()
# * @method static \GuzzleHttp\Psr7\RequestInterface runBeforeSendingCallbacks(\GuzzleHttp\Psr7\RequestInterface
$request, array $options)
# * @method static array mergeOptions(array ...$options)
# * @method static \Illuminate\Http\Client\PendingRequest stub(callable $callback)
# * @method static \Illuminate\Http\Client\PendingRequest async(bool $async = true)
# * @method static \GuzzleHttp\Promise\PromiseInterface|null getPromise()
# * @method static \Illuminate\Http\Client\PendingRequest setClient(\GuzzleHttp\Client
$client)
# * @method static \Illuminate\Http\Client\PendingRequest setHandler(callable $handler)
# * @method static array getOptions()
# * @method static \Illuminate\Http\Client\PendingRequest|mixed when(\Closure|mixed|null
$value = null, callable|null $callback = null, callable|null $default = null)
# * @method static \Illuminate\Http\Client\PendingRequest|mixed unless(\Closure|mixed|null
$value = null, callable|null $callback = null, callable|null $default = null)
# *
# * @see \Illuminate\Http\Client\Factory'
dependencies:
- name: Factory
type: class
source: Illuminate\Http\Client\Factory
properties: []
methods:
- name: getFacadeAccessor
visibility: protected
parameters: []
comment: '# * @method static \Illuminate\Http\Client\Factory globalMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalRequestMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalResponseMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\Factory globalOptions(\Closure|array
$options)
# * @method static \GuzzleHttp\Promise\PromiseInterface response(array|string|null
$body = null, int $status = 200, array $headers = [])
# * @method static \Illuminate\Http\Client\ResponseSequence sequence(array $responses
= [])
# * @method static \Illuminate\Http\Client\Factory allowStrayRequests()
# * @method static void recordRequestResponsePair(\Illuminate\Http\Client\Request
$request, \Illuminate\Http\Client\Response $response)
# * @method static void assertSent(callable $callback)
# * @method static void assertSentInOrder(array $callbacks)
# * @method static void assertNotSent(callable $callback)
# * @method static void assertNothingSent()
# * @method static void assertSentCount(int $count)
# * @method static void assertSequencesAreEmpty()
# * @method static \Illuminate\Support\Collection recorded(callable $callback
= null)
# * @method static \Illuminate\Http\Client\PendingRequest createPendingRequest()
# * @method static \Illuminate\Contracts\Events\Dispatcher|null getDispatcher()
# * @method static array getGlobalMiddleware()
# * @method static void macro(string $name, object|callable $macro, object|callable
$macro = null)
# * @method static void mixin(object $mixin, bool $replace = true)
# * @method static bool hasMacro(string $name)
# * @method static void flushMacros()
# * @method static mixed macroCall(string $method, array $parameters)
# * @method static \Illuminate\Http\Client\PendingRequest baseUrl(string $url)
# * @method static \Illuminate\Http\Client\PendingRequest withBody(\Psr\Http\Message\StreamInterface|string
$content, string $contentType = ''application/json'')
# * @method static \Illuminate\Http\Client\PendingRequest asJson()
# * @method static \Illuminate\Http\Client\PendingRequest asForm()
# * @method static \Illuminate\Http\Client\PendingRequest attach(string|array
$name, string|resource $contents = '''', string|null $filename = null, array $headers
= [])
# * @method static \Illuminate\Http\Client\PendingRequest asMultipart()
# * @method static \Illuminate\Http\Client\PendingRequest bodyFormat(string $format)
# * @method static \Illuminate\Http\Client\PendingRequest withQueryParameters(array
$parameters)
# * @method static \Illuminate\Http\Client\PendingRequest contentType(string $contentType)
# * @method static \Illuminate\Http\Client\PendingRequest acceptJson()
# * @method static \Illuminate\Http\Client\PendingRequest accept(string $contentType)
# * @method static \Illuminate\Http\Client\PendingRequest withHeaders(array $headers)
# * @method static \Illuminate\Http\Client\PendingRequest withHeader(string $name,
mixed $value)
# * @method static \Illuminate\Http\Client\PendingRequest replaceHeaders(array
$headers)
# * @method static \Illuminate\Http\Client\PendingRequest withBasicAuth(string
$username, string $password)
# * @method static \Illuminate\Http\Client\PendingRequest withDigestAuth(string
$username, string $password)
# * @method static \Illuminate\Http\Client\PendingRequest withToken(string $token,
string $type = ''Bearer'')
# * @method static \Illuminate\Http\Client\PendingRequest withUserAgent(string|bool
$userAgent)
# * @method static \Illuminate\Http\Client\PendingRequest withUrlParameters(array
$parameters = [])
# * @method static \Illuminate\Http\Client\PendingRequest withCookies(array $cookies,
string $domain)
# * @method static \Illuminate\Http\Client\PendingRequest maxRedirects(int $max)
# * @method static \Illuminate\Http\Client\PendingRequest withoutRedirecting()
# * @method static \Illuminate\Http\Client\PendingRequest withoutVerifying()
# * @method static \Illuminate\Http\Client\PendingRequest sink(string|resource
$to)
# * @method static \Illuminate\Http\Client\PendingRequest timeout(int $seconds)
# * @method static \Illuminate\Http\Client\PendingRequest connectTimeout(int $seconds)
# * @method static \Illuminate\Http\Client\PendingRequest retry(array|int $times,
\Closure|int $sleepMilliseconds = 0, callable|null $when = null, bool $throw =
true)
# * @method static \Illuminate\Http\Client\PendingRequest withOptions(array $options)
# * @method static \Illuminate\Http\Client\PendingRequest withMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest withRequestMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest withResponseMiddleware(callable
$middleware)
# * @method static \Illuminate\Http\Client\PendingRequest beforeSending(callable
$callback)
# * @method static \Illuminate\Http\Client\PendingRequest throw(callable|null
$callback = null)
# * @method static \Illuminate\Http\Client\PendingRequest throwIf(callable|bool
$condition)
# * @method static \Illuminate\Http\Client\PendingRequest throwUnless(bool $condition)
# * @method static \Illuminate\Http\Client\PendingRequest dump()
# * @method static \Illuminate\Http\Client\PendingRequest dd()
# * @method static \Illuminate\Http\Client\Response get(string $url, array|string|null
$query = null)
# * @method static \Illuminate\Http\Client\Response head(string $url, array|string|null
$query = null)
# * @method static \Illuminate\Http\Client\Response post(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response patch(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response put(string $url, array $data
= [])
# * @method static \Illuminate\Http\Client\Response delete(string $url, array
$data = [])
# * @method static array pool(callable $callback)
# * @method static \Illuminate\Http\Client\Response send(string $method, string
$url, array $options = [])
# * @method static \GuzzleHttp\Client buildClient()
# * @method static \GuzzleHttp\Client createClient(\GuzzleHttp\HandlerStack $handlerStack)
# * @method static \GuzzleHttp\HandlerStack buildHandlerStack()
# * @method static \GuzzleHttp\HandlerStack pushHandlers(\GuzzleHttp\HandlerStack
$handlerStack)
# * @method static \Closure buildBeforeSendingHandler()
# * @method static \Closure buildRecorderHandler()
# * @method static \Closure buildStubHandler()
# * @method static \GuzzleHttp\Psr7\RequestInterface runBeforeSendingCallbacks(\GuzzleHttp\Psr7\RequestInterface
$request, array $options)
# * @method static array mergeOptions(array ...$options)
# * @method static \Illuminate\Http\Client\PendingRequest stub(callable $callback)
# * @method static \Illuminate\Http\Client\PendingRequest async(bool $async =
true)
# * @method static \GuzzleHttp\Promise\PromiseInterface|null getPromise()
# * @method static \Illuminate\Http\Client\PendingRequest setClient(\GuzzleHttp\Client
$client)
# * @method static \Illuminate\Http\Client\PendingRequest setHandler(callable
$handler)
# * @method static array getOptions()
# * @method static \Illuminate\Http\Client\PendingRequest|mixed when(\Closure|mixed|null
$value = null, callable|null $callback = null, callable|null $default = null)
# * @method static \Illuminate\Http\Client\PendingRequest|mixed unless(\Closure|mixed|null
$value = null, callable|null $callback = null, callable|null $default = null)
# *
# * @see \Illuminate\Http\Client\Factory
# */
# class Http extends Facade
# {
# /**
# * Get the registered name of the component.
# *
# * @return string'
- name: fake
visibility: public
parameters:
- name: callback
default: 'null'
comment: '# * Register a stub callable that will intercept requests and be able
to return stub responses.
# *
# * @param \Closure|array $callback
# * @return \Illuminate\Http\Client\Factory'
- name: fakeSequence
visibility: public
parameters:
- name: urlPattern
default: '''*'''
comment: '# * Register a response sequence for the given URL pattern.
# *
# * @param string $urlPattern
# * @return \Illuminate\Http\Client\ResponseSequence'
- name: preventStrayRequests
visibility: public
parameters: []
comment: '# * Indicate that an exception should be thrown if any request is not
faked.
# *
# * @return \Illuminate\Http\Client\Factory'
- name: stubUrl
visibility: public
parameters:
- name: url
- name: callback
comment: '# * Stub the given URL using the given callback.
# *
# * @param string $url
# * @param \Illuminate\Http\Client\Response|\GuzzleHttp\Promise\PromiseInterface|callable $callback
# * @return \Illuminate\Http\Client\Factory'
traits:
- Illuminate\Http\Client\Factory
interfaces: []