class Response extends Facade

Constants

protected STATE_CONTEXT_KEY

The context key for the coroutine-local facade roots.

Properties

static protected Container|null $app

The application instance being facaded.

from  Facade
static protected array $resolvedInstance

The resolved object instances.

from  Facade
static protected array<string, true> $scopedAccessors

Accessors whose resolved objects belong to a coroutine scope.

from  Facade
static protected array<string, int> $coroutineAccessors

Accessors with coroutine-local roots, and their current generation.

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|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|null $app)

Set the application instance.

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

Handle dynamic, static calls to the object.

from  Facade
static BinaryFileResponse
download(SplFileInfo|string $file, string|null $name = 'null', array $headers = '[]', string $disposition = '\'attachment\'')

No description

eventStream(Closure $callback, array $headers = '[]', StreamedEvent|string|null $endStreamWith = '\'</stream>\'')

No description

static BinaryFileResponse
file(SplFileInfo|string $file, array $headers = '[]')

No description

static void
flushMacros()

No description

static void
flushState()

No description

static bool
hasMacro(string $name)

No description

static JsonResponse
json(mixed $data = '[]', int $status = '200', array $headers = '[]', int $options = '0')

No description

static JsonResponse
jsonp(string $callback, mixed $data = '[]', int $status = '200', array $headers = '[]', int $options = '0')

No description

static void
macro(string $name, callable|object $macro)

No description

static Response
make(mixed $content = '\'\'', int $status = '200', array $headers = '[]')

No description

static Response
markdown(string $content = '\'\'', int $status = '200', array $headers = '[]')

No description

static void
mixin(object $mixin, bool $replace = 'true')

No description

static Response
noContent(int $status = '204', array $headers = '[]')

No description

redirectGuest(string $path, int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

redirectTo(string $path, int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

redirectToAction(array|string $action, mixed $parameters = '[]', int $status = '302', array $headers = '[]')

No description

redirectToIntended(string $default = '\'/\'', int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

redirectToRoute(BackedEnum|string $route, mixed $parameters = '[]', int $status = '302', array $headers = '[]')

No description

static StreamedResponse
stream(callable|null $callback = 'null', int $status = '200', array $headers = '[]')

No description

static StreamedResponse
streamDownload(callable $callback, string|null $name = 'null', array $headers = '[]', string $disposition = '\'attachment\'')

No description

static StreamedJsonResponse
streamJson(array $data, int $status = '200', array $headers = '[]', int $encodingOptions = '15')

No description

static Response
view(array|string $view, array $data = '[]', int $status = '200', array $headers = '[]')

No description

Details

in Facade at line 85
static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.

Parameters

Closure $callback

Return Value

void

in Facade at line 106
static MockInterface|null spy()

Convert the facade into a Mockery spy.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface|null

in Facade at line 125
static MockInterface partialMock()

Initiate a partial mock on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 142
static CompositeExpectation|Expectation|HigherOrderMessage shouldReceive()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

in Facade at line 159
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage expects()

Initiate a mock expectation on the facade.

Swaps the resolved facade instance for the worker lifetime.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 176
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Swaps the resolved facade instance for the worker lifetime.

Return Value

MockInterface

in Facade at line 189
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 199
static protected bool isMock()

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

Return Value

bool

in Facade at line 210
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

in Facade at line 226
static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.

Parameters

mixed $instance

Return Value

void

in Facade at line 239
static bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

in Facade at line 250
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 40
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 266
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

in Facade at line 312
static void clearResolvedInstance(string|null $name = null)

Clear a resolved facade instance.

Later facade calls everywhere resolve again; only references already held keep the previous instance.

Parameters

string|null $name

Return Value

void

in Facade at line 330
static void clearResolvedInstances()

Clear all of the resolved instances.

Later facade calls everywhere resolve again; only references already held keep the previous instances.

Return Value

void

in Facade at line 344
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 404
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

in Facade at line 415
static void setFacadeApplication(Container|null $app)

Set the application instance.

Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.

Parameters

Container|null $app

Return Value

void

in Facade at line 427
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException
Throwable

at line 35
static BinaryFileResponse download(SplFileInfo|string $file, string|null $name = 'null', array $headers = '[]', string $disposition = '\'attachment\'')

No description

Parameters

SplFileInfo|string $file
string|null $name
array $headers
string $disposition

Return Value

BinaryFileResponse

at line 35
static IterableStreamedResponse eventStream(Closure $callback, array $headers = '[]', StreamedEvent|string|null $endStreamWith = '\'</stream>\'')

No description

Parameters

Closure $callback
array $headers
StreamedEvent|string|null $endStreamWith

Return Value

IterableStreamedResponse

at line 35
static BinaryFileResponse file(SplFileInfo|string $file, array $headers = '[]')

No description

Parameters

SplFileInfo|string $file
array $headers

Return Value

BinaryFileResponse

at line 35
static void flushMacros()

No description

Return Value

void

at line 35
static void flushState()

No description

Return Value

void

at line 35
static bool hasMacro(string $name)

No description

Parameters

string $name

Return Value

bool

at line 35
static JsonResponse json(mixed $data = '[]', int $status = '200', array $headers = '[]', int $options = '0')

No description

Parameters

mixed $data
int $status
array $headers
int $options

Return Value

JsonResponse

at line 35
static JsonResponse jsonp(string $callback, mixed $data = '[]', int $status = '200', array $headers = '[]', int $options = '0')

No description

Parameters

string $callback
mixed $data
int $status
array $headers
int $options

Return Value

JsonResponse

at line 35
static void macro(string $name, callable|object $macro)

No description

Parameters

string $name
callable|object $macro

Return Value

void

at line 35
static Response make(mixed $content = '\'\'', int $status = '200', array $headers = '[]')

No description

Parameters

mixed $content
int $status
array $headers

Return Value

Response

at line 35
static Response markdown(string $content = '\'\'', int $status = '200', array $headers = '[]')

No description

Parameters

string $content
int $status
array $headers

Return Value

Response

at line 35
static void mixin(object $mixin, bool $replace = 'true')

No description

Parameters

object $mixin
bool $replace

Return Value

void

at line 35
static Response noContent(int $status = '204', array $headers = '[]')

No description

Parameters

int $status
array $headers

Return Value

Response

at line 35
static RedirectResponse redirectGuest(string $path, int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

Parameters

string $path
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse

at line 35
static RedirectResponse redirectTo(string $path, int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

Parameters

string $path
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse

at line 35
static RedirectResponse redirectToAction(array|string $action, mixed $parameters = '[]', int $status = '302', array $headers = '[]')

No description

Parameters

array|string $action
mixed $parameters
int $status
array $headers

Return Value

RedirectResponse

at line 35
static RedirectResponse redirectToIntended(string $default = '\'/\'', int $status = '302', array $headers = '[]', bool|null $secure = 'null')

No description

Parameters

string $default
int $status
array $headers
bool|null $secure

Return Value

RedirectResponse

at line 35
static RedirectResponse redirectToRoute(BackedEnum|string $route, mixed $parameters = '[]', int $status = '302', array $headers = '[]')

No description

Parameters

BackedEnum|string $route
mixed $parameters
int $status
array $headers

Return Value

RedirectResponse

at line 35
static StreamedResponse stream(callable|null $callback = 'null', int $status = '200', array $headers = '[]')

No description

Parameters

callable|null $callback
int $status
array $headers

Return Value

StreamedResponse

at line 35
static StreamedResponse streamDownload(callable $callback, string|null $name = 'null', array $headers = '[]', string $disposition = '\'attachment\'')

No description

Parameters

callable $callback
string|null $name
array $headers
string $disposition

Return Value

StreamedResponse

at line 35
static StreamedJsonResponse streamJson(array $data, int $status = '200', array $headers = '[]', int $encodingOptions = '15')

No description

Parameters

array $data
int $status
array $headers
int $encodingOptions

Return Value

StreamedJsonResponse

at line 35
static Response view(array|string $view, array $data = '[]', int $status = '200', array $headers = '[]')

No description

Parameters

array|string $view
array $data
int $status
array $headers

Return Value

Response