Http
class Http extends Facade (View source)
Properties
| static protected Application | $app | The application instance being facaded. |
from Facade |
| static protected array | $resolvedInstance | The resolved object instances. |
from Facade |
| static protected bool | $cached | Indicates if the resolved instance should be cached. |
from Facade |
Methods
| static void | resolved(Closure $callback) Run a Closure when the facade has been resolved. |
from Facade |
| static MockInterface | spy() Convert the facade into a Mockery spy. |
from Facade |
| static MockInterface | partialMock() Initiate a partial mock on the facade. |
from Facade |
| static Expectation | shouldReceive() Initiate a mock expectation on the facade. |
from Facade |
| static Expectation | expects() Initiate a mock expectation on the facade. |
from Facade |
| static MockInterface | createFreshMockInstance() Create a fresh mock instance for the given class. |
from Facade |
| static MockInterface | createMock() Create a fresh mock instance for the given class. |
from Facade |
| static bool | isMock() Determines whether a mock is set as the instance of the facade. |
from Facade |
| static string|null | getMockableClass() Get the mockable class for the bound instance. |
from Facade |
| static void | swap(mixed $instance) Hotswap the underlying instance behind the facade. |
from Facade |
| static bool | isFake() Determines whether a "fake" has been set as the facade instance. |
from Facade |
| static mixed | getFacadeRoot() Get the root object behind the facade. |
from Facade |
| static string | getFacadeAccessor() Get the registered name of the component. |
|
| static mixed | resolveFacadeInstance(string $name) Resolve the facade root instance from the container. |
from Facade |
| static void | clearResolvedInstance(string $name) Clear a resolved facade instance. |
from Facade |
| static void | clearResolvedInstances() Clear all of the resolved instances. |
from Facade |
| static Collection | defaultAliases() Get the application default aliases. |
from Facade |
| static Application | getFacadeApplication() Get the application instance behind the facade. |
from Facade |
| static void | setFacadeApplication(Application $app) Set the application instance. |
from Facade |
| static mixed | __callStatic(string $method, array $args) Handle dynamic, static calls to the object. |
from Facade |
| static Factory | fake(Closure|array $callback = null) Register a stub callable that will intercept requests and be able to return stub responses. |
|
| static ResponseSequence | fakeSequence(string $urlPattern = '*') Register a response sequence for the given URL pattern. |
|
| static Factory | preventStrayRequests() Indicate that an exception should be thrown if any request is not faked. |
|
| static Factory | stubUrl(string $url, Response|PromiseInterface|callable $callback) Stub the given URL using the given callback. |
|
| static PromiseInterface | response(array|string|null $body = null, int $status = 200, array $headers = []) No description |
|
| static ResponseSequence | sequence(array $responses = []) No description |
|
| static Factory | allowStrayRequests() No description |
|
| static void | recordRequestResponsePair(Request $request, Response $response) No description |
|
| static void | assertSent(callable $callback) No description |
|
| static void | assertSentInOrder(array $callbacks) No description |
|
| static void | assertNotSent(callable $callback) No description |
|
| static void | assertNothingSent() No description |
|
| static void | assertSentCount(int $count) No description |
|
| static void | assertSequencesAreEmpty() No description |
|
| static Collection | recorded(callable $callback = null) No description |
|
| static Dispatcher|null | getDispatcher() No description |
|
| static void | macro(string $name, object|callable $macro) No description |
|
| static void | mixin(object $mixin, bool $replace = true) No description |
|
| static bool | hasMacro(string $name) No description |
|
| static void | flushMacros() No description |
|
| static mixed | macroCall(string $method, array $parameters) No description |
|
| static PendingRequest | baseUrl(string $url) No description |
|
| static PendingRequest | withBody(string $content, string $contentType = 'application/json') No description |
|
| static PendingRequest | asJson() No description |
|
| static PendingRequest | asForm() No description |
|
| static PendingRequest | attach(string|array $name, string|resource $contents = '', string|null $filename = null, array $headers = []) No description |
|
| static PendingRequest | asMultipart() No description |
|
| static PendingRequest | bodyFormat(string $format) No description |
|
| static PendingRequest | contentType(string $contentType) No description |
|
| static PendingRequest | acceptJson() No description |
|
| static PendingRequest | accept(string $contentType) No description |
|
| static PendingRequest | withHeaders(array $headers) No description |
|
| static PendingRequest | replaceHeaders(array $headers) No description |
|
| static PendingRequest | withBasicAuth(string $username, string $password) No description |
|
| static PendingRequest | withDigestAuth(string $username, string $password) No description |
|
| static PendingRequest | withToken(string $token, string $type = 'Bearer') No description |
|
| static PendingRequest | withUserAgent(string|bool $userAgent) No description |
|
| static PendingRequest | withUrlParameters(array $parameters = []) No description |
|
| static PendingRequest | withCookies(array $cookies, string $domain) No description |
|
| static PendingRequest | maxRedirects(int $max) No description |
|
| static PendingRequest | withoutRedirecting() No description |
|
| static PendingRequest | withoutVerifying() No description |
|
| static PendingRequest | sink(string|resource $to) No description |
|
| static PendingRequest | timeout(int $seconds) No description |
|
| static PendingRequest | connectTimeout(int $seconds) No description |
|
| static PendingRequest | retry(int $times, Closure|int $sleepMilliseconds, callable|null $when = null, bool $throw = true) No description |
|
| static PendingRequest | withOptions(array $options) No description |
|
| static PendingRequest | withMiddleware(callable $middleware) No description |
|
| static PendingRequest | beforeSending(callable $callback) No description |
|
| static PendingRequest | throw(callable|null $callback = null) No description |
|
| static PendingRequest | throwIf(callable|bool $condition, callable|null $throwCallback = null) No description |
|
| static PendingRequest | throwUnless(bool $condition) No description |
|
| static PendingRequest | dump() No description |
|
| static PendingRequest | dd() No description |
|
| static Response | get(string $url, array|string|null $query = null) No description |
|
| static Response | head(string $url, array|string|null $query = null) No description |
|
| static Response | post(string $url, array $data = []) No description |
|
| static Response | patch(string $url, array $data = []) No description |
|
| static Response | put(string $url, array $data = []) No description |
|
| static Response | delete(string $url, array $data = []) No description |
|
| static array | pool(callable $callback) No description |
|
| static Response | send(string $method, string $url, array $options = []) No description |
|
| static Client | buildClient() No description |
|
| static Client | createClient(HandlerStack $handlerStack) No description |
|
| static HandlerStack | buildHandlerStack() No description |
|
| static HandlerStack | pushHandlers(HandlerStack $handlerStack) No description |
|
| static Closure | buildBeforeSendingHandler() No description |
|
| static Closure | buildRecorderHandler() No description |
|
| static Closure | buildStubHandler() No description |
|
| static RequestInterface | runBeforeSendingCallbacks(RequestInterface $request, array $options) No description |
|
| static array | mergeOptions(array $options) No description |
|
| static PendingRequest | stub(callable $callback) No description |
|
| static PendingRequest | async(bool $async = true) No description |
|
| static PromiseInterface|null | getPromise() No description |
|
| static PendingRequest | setClient(Client $client) No description |
|
| static PendingRequest | setHandler(callable $handler) No description |
|
| static array | getOptions() No description |
|
| static PendingRequest|mixed | when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null) No description |
|
| static PendingRequest|mixed | unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null) No description |
Details
static void resolved(Closure $callback)
Run a Closure when the facade has been resolved.
static MockInterface spy()
Convert the facade into a Mockery spy.
static MockInterface partialMock()
Initiate a partial mock on the facade.
static Expectation shouldReceive()
Initiate a mock expectation on the facade.
static Expectation expects()
Initiate a mock expectation on the facade.
static protected MockInterface createFreshMockInstance()
Create a fresh mock instance for the given class.
static protected MockInterface createMock()
Create a fresh mock instance for the given class.
static protected bool isMock()
Determines whether a mock is set as the instance of the facade.
static protected string|null getMockableClass()
Get the mockable class for the bound instance.
static void swap(mixed $instance)
Hotswap the underlying instance behind the facade.
static protected bool isFake()
Determines whether a "fake" has been set as the facade instance.
static mixed getFacadeRoot()
Get the root object behind the facade.
static protected string getFacadeAccessor()
Get the registered name of the component.
static protected mixed resolveFacadeInstance(string $name)
Resolve the facade root instance from the container.
static void clearResolvedInstance(string $name)
Clear a resolved facade instance.
static void clearResolvedInstances()
Clear all of the resolved instances.
static Collection defaultAliases()
Get the application default aliases.
static Application getFacadeApplication()
Get the application instance behind the facade.
static void setFacadeApplication(Application $app)
Set the application instance.
static mixed __callStatic(string $method, array $args)
Handle dynamic, static calls to the object.
static Factory fake(Closure|array $callback = null)
Register a stub callable that will intercept requests and be able to return stub responses.
static ResponseSequence fakeSequence(string $urlPattern = '*')
Register a response sequence for the given URL pattern.
static Factory preventStrayRequests()
Indicate that an exception should be thrown if any request is not faked.
static Factory stubUrl(string $url, Response|PromiseInterface|callable $callback)
Stub the given URL using the given callback.
static PromiseInterface response(array|string|null $body = null, int $status = 200, array $headers = [])
No description
static ResponseSequence sequence(array $responses = [])
No description
static Factory allowStrayRequests()
No description
static void assertSent(callable $callback)
No description
static void assertSentInOrder(array $callbacks)
No description
static void assertNotSent(callable $callback)
No description
static void assertNothingSent()
No description
static void assertSentCount(int $count)
No description
static void assertSequencesAreEmpty()
No description
static Collection recorded(callable $callback = null)
No description
static Dispatcher|null getDispatcher()
No description
static void macro(string $name, object|callable $macro)
No description
static void mixin(object $mixin, bool $replace = true)
No description
static bool hasMacro(string $name)
No description
static void flushMacros()
No description
static mixed macroCall(string $method, array $parameters)
No description
static PendingRequest baseUrl(string $url)
No description
static PendingRequest withBody(string $content, string $contentType = 'application/json')
No description
static PendingRequest asJson()
No description
static PendingRequest asForm()
No description
static PendingRequest attach(string|array $name, string|resource $contents = '', string|null $filename = null, array $headers = [])
No description
static PendingRequest asMultipart()
No description
static PendingRequest bodyFormat(string $format)
No description
static PendingRequest contentType(string $contentType)
No description
static PendingRequest acceptJson()
No description
static PendingRequest accept(string $contentType)
No description
static PendingRequest withHeaders(array $headers)
No description
static PendingRequest replaceHeaders(array $headers)
No description
static PendingRequest withBasicAuth(string $username, string $password)
No description
static PendingRequest withDigestAuth(string $username, string $password)
No description
static PendingRequest withToken(string $token, string $type = 'Bearer')
No description
static PendingRequest withUserAgent(string|bool $userAgent)
No description
static PendingRequest withUrlParameters(array $parameters = [])
No description
static PendingRequest withCookies(array $cookies, string $domain)
No description
static PendingRequest maxRedirects(int $max)
No description
static PendingRequest withoutRedirecting()
No description
static PendingRequest withoutVerifying()
No description
static PendingRequest sink(string|resource $to)
No description
static PendingRequest timeout(int $seconds)
No description
static PendingRequest connectTimeout(int $seconds)
No description
static PendingRequest retry(int $times, Closure|int $sleepMilliseconds, callable|null $when = null, bool $throw = true)
No description
static PendingRequest withOptions(array $options)
No description
static PendingRequest withMiddleware(callable $middleware)
No description
static PendingRequest beforeSending(callable $callback)
No description
static PendingRequest throw(callable|null $callback = null)
No description
static PendingRequest throwIf(callable|bool $condition, callable|null $throwCallback = null)
No description
static PendingRequest throwUnless(bool $condition)
No description
static PendingRequest dump()
No description
static PendingRequest dd()
No description
static Response get(string $url, array|string|null $query = null)
No description
static Response head(string $url, array|string|null $query = null)
No description
static Response post(string $url, array $data = [])
No description
static Response patch(string $url, array $data = [])
No description
static Response put(string $url, array $data = [])
No description
static Response delete(string $url, array $data = [])
No description
static array pool(callable $callback)
No description
static Response send(string $method, string $url, array $options = [])
No description
static Client buildClient()
No description
static Client createClient(HandlerStack $handlerStack)
No description
static HandlerStack buildHandlerStack()
No description
static HandlerStack pushHandlers(HandlerStack $handlerStack)
No description
static Closure buildBeforeSendingHandler()
No description
static Closure buildRecorderHandler()
No description
static Closure buildStubHandler()
No description
static RequestInterface runBeforeSendingCallbacks(RequestInterface $request, array $options)
No description
static array mergeOptions(array $options)
No description
static PendingRequest stub(callable $callback)
No description
static PendingRequest async(bool $async = true)
No description
static PromiseInterface|null getPromise()
No description
static PendingRequest setClient(Client $client)
No description
static PendingRequest setHandler(callable $handler)
No description
static array getOptions()
No description
static PendingRequest|mixed when(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
No description
static PendingRequest|mixed unless(Closure|mixed|null $value = null, callable|null $callback = null, callable|null $default = null)
No description
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Http.html