laravel / 8 / api / 8.x / illuminate / support / facades / http.html

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

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 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 mixed getFacadeRoot()

Get the root object behind the facade.

from Facade
static string getFacadeAccessor()

Get the registered name of the component.

static mixed resolveFacadeInstance(object|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 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 PromiseInterface response(mixed $body, mixed $status, mixed $headers)

No description

static Factory fake(mixed $callback)

No description

static PendingRequest accept(string $contentType)

No description

static PendingRequest acceptJson()

No description

static PendingRequest asForm()

No description

static PendingRequest asJson()

No description

static PendingRequest asMultipart()

No description

static PendingRequest async()

No description

static PendingRequest attach(string|array $name, string $contents = '', string|null $filename = null, array $headers = [])

No description

static PendingRequest baseUrl(string $url)

No description

static PendingRequest beforeSending(callable $callback)

No description

static PendingRequest bodyFormat(string $format)

No description

static PendingRequest contentType(string $contentType)

No description

static PendingRequest dd()

No description

static PendingRequest dump()

No description

static PendingRequest retry(int $times, int $sleep, ?callable $when = null)

No description

static PendingRequest sink(string|resource $to)

No description

static PendingRequest stub(callable $callback)

No description

static PendingRequest timeout(int $seconds)

No description

static PendingRequest withBasicAuth(string $username, string $password)

No description

static PendingRequest withBody(resource|string $content, string $contentType)

No description

static PendingRequest withCookies(array $cookies, string $domain)

No description

static PendingRequest withDigestAuth(string $username, string $password)

No description

static PendingRequest withHeaders(array $headers)

No description

static PendingRequest withMiddleware(callable $middleware)

No description

static PendingRequest withOptions(array $options)

No description

static PendingRequest withToken(string $token, string $type = 'Bearer')

No description

static PendingRequest withUserAgent(string $userAgent)

No description

static PendingRequest withoutRedirecting()

No description

static PendingRequest withoutVerifying()

No description

static array pool(callable $callback)

No description

static Response delete(string $url, array $data = [])

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 patch(string $url, array $data = [])

No description

static Response post(string $url, array $data = [])

No description

static Response put(string $url, array $data = [])

No description

static Response send(string $method, string $url, array $options = [])

No description

static ResponseSequence fakeSequence(string $urlPattern = '*')

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

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(object|string $name)

Resolve the facade root instance from the container.

Parameters

object|string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Application getFacadeApplication()

Get the application instance behind the facade.

Return Value

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

static PromiseInterface response(mixed $body, mixed $status, mixed $headers)

No description

Parameters

mixed $body
mixed $status
mixed $headers

Return Value

PromiseInterface

static Factory fake(mixed $callback)

No description

Parameters

mixed $callback

Return Value

static PendingRequest accept(string $contentType)

No description

Parameters

string $contentType

Return Value

static PendingRequest acceptJson()

No description

Return Value

static PendingRequest asForm()

No description

Return Value

static PendingRequest asJson()

No description

Return Value

static PendingRequest asMultipart()

No description

Return Value

static PendingRequest async()

No description

Return Value

static PendingRequest attach(string|array $name, string $contents = '', string|null $filename = null, array $headers = [])

No description

Parameters

string|array $name
string $contents
string|null $filename
array $headers

Return Value

static PendingRequest baseUrl(string $url)

No description

Parameters

string $url

Return Value

static PendingRequest beforeSending(callable $callback)

No description

Parameters

callable $callback

Return Value

static PendingRequest bodyFormat(string $format)

No description

Parameters

string $format

Return Value

static PendingRequest contentType(string $contentType)

No description

Parameters

string $contentType

Return Value

static PendingRequest dd()

No description

Return Value

static PendingRequest dump()

No description

Return Value

static PendingRequest retry(int $times, int $sleep, ?callable $when = null)

No description

Parameters

int $times
int $sleep
?callable $when

Return Value

static PendingRequest sink(string|resource $to)

No description

Parameters

string|resource $to

Return Value

static PendingRequest stub(callable $callback)

No description

Parameters

callable $callback

Return Value

static PendingRequest timeout(int $seconds)

No description

Parameters

int $seconds

Return Value

static PendingRequest withBasicAuth(string $username, string $password)

No description

Parameters

string $username
string $password

Return Value

static PendingRequest withBody(resource|string $content, string $contentType)

No description

Parameters

resource|string $content
string $contentType

Return Value

static PendingRequest withCookies(array $cookies, string $domain)

No description

Parameters

array $cookies
string $domain

Return Value

static PendingRequest withDigestAuth(string $username, string $password)

No description

Parameters

string $username
string $password

Return Value

static PendingRequest withHeaders(array $headers)

No description

Parameters

array $headers

Return Value

static PendingRequest withMiddleware(callable $middleware)

No description

Parameters

callable $middleware

Return Value

static PendingRequest withOptions(array $options)

No description

Parameters

array $options

Return Value

static PendingRequest withToken(string $token, string $type = 'Bearer')

No description

Parameters

string $token
string $type

Return Value

static PendingRequest withUserAgent(string $userAgent)

No description

Parameters

string $userAgent

Return Value

static PendingRequest withoutRedirecting()

No description

Return Value

static PendingRequest withoutVerifying()

No description

Return Value

static array pool(callable $callback)

No description

Parameters

callable $callback

Return Value

array

static Response delete(string $url, array $data = [])

No description

Parameters

string $url
array $data

Return Value

static Response get(string $url, array|string|null $query = null)

No description

Parameters

string $url
array|string|null $query

Return Value

static Response head(string $url, array|string|null $query = null)

No description

Parameters

string $url
array|string|null $query

Return Value

static Response patch(string $url, array $data = [])

No description

Parameters

string $url
array $data

Return Value

static Response post(string $url, array $data = [])

No description

Parameters

string $url
array $data

Return Value

static Response put(string $url, array $data = [])

No description

Parameters

string $url
array $data

Return Value

static Response send(string $method, string $url, array $options = [])

No description

Parameters

string $method
string $url
array $options

Return Value

static ResponseSequence fakeSequence(string $urlPattern = '*')

No description

Parameters

string $urlPattern

Return Value

static void assertSent(callable $callback)

No description

Parameters

callable $callback

Return Value

void

static void assertSentInOrder(array $callbacks)

No description

Parameters

array $callbacks

Return Value

void

static void assertNotSent(callable $callback)

No description

Parameters

callable $callback

Return Value

void

static void assertNothingSent()

No description

Return Value

void

static void assertSentCount(int $count)

No description

Parameters

int $count

Return Value

void

static void assertSequencesAreEmpty()

No description

Return Value

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Support/Facades/Http.html