Factory
class Factory mixin PendingRequest (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Dispatcher|null | $dispatcher | The event dispatcher implementation. |
|
| protected array | $globalMiddleware | The middleware to apply to every request. |
|
| protected Closure|array | $globalOptions | The options to apply to every request. |
|
| protected Collection | $stubCallbacks | The stub callables that will handle requests. |
|
| protected bool | $recording | Indicates if the factory is recording requests and responses. |
|
| protected Response|null}> | $recorded | The recorded response array. |
|
| protected ResponseSequence> | $responseSequences | All created response sequences. |
|
| protected bool | $preventStrayRequests | Indicates that an exception should be thrown if any request is not faked. |
|
| protected array<int, string> | $allowedStrayRequestUrls | A list of URL patterns that are allowed to bypass the stray request guard. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Execute a method against a new pending request instance.
Add middleware to apply to every request.
Add request middleware to apply to every request.
Add response middleware to apply to every request.
Create a new response instance for use during stubbing.
Create a new PSR-7 response instance for use during stubbing.
Normalize the given fake response headers.
Normalize a scalar to a string without triggering PHP 8.5 non-finite float warnings.
Create a new RequestException instance for use during stubbing.
Create a new connection exception for use during stubbing.
Get an invokable object that returns a sequence of responses in order for use during stubbing.
Register a stub callable that will intercept requests and be able to return stub responses.
Register a response sequence for the given URL pattern.
Stub the given URL using the given callback.
Indicate that an exception should be thrown if any request is not faked.
Determine if stray requests are being prevented.
Allow stray, unfaked requests entirely, or optionally allow only specific URLs.
Begin recording request / response pairs.
Record a request response pair.
Assert that a request / response pair was recorded matching a given truth test.
Assert that the given request was sent in the given order.
Assert that a request / response pair was not recorded matching a given truth test.
Assert that no request / response pair was recorded.
Assert how many requests have been recorded.
Assert that every created response sequence is empty.
Get a collection of the request / response pairs matching the given truth test.
Create a new pending request instance for this factory.
Instantiate a new pending request instance for this factory.
Get the current event dispatcher implementation.
Get the array of global middleware.
Details
static void
macro(string $name, object|callable $macro)
Register a custom macro.
static void
mixin(object $mixin, bool $replace = true)
Mix another object into the class.
static bool
hasMacro(string $name)
Checks if macro is registered.
static void
flushMacros()
Flush the existing macros.
static mixed
__callStatic(string $method, array $parameters)
Dynamically handle calls to the class.
mixed
__call(string $method, array $parameters)
Execute a method against a new pending request instance.
__construct(Dispatcher|null $dispatcher = null)
Create a new factory instance.
$this
globalMiddleware(callable $middleware)
Add middleware to apply to every request.
$this
globalRequestMiddleware(callable $middleware)
Add request middleware to apply to every request.
$this
globalResponseMiddleware(callable $middleware)
Add response middleware to apply to every request.
$this
globalOptions(Closure|array $options)
Set the options to apply to every request.
static PromiseInterface
response(array|string|null $body = null, int $status = 200, array $headers = [])
Create a new response instance for use during stubbing.
static Response
psr7Response(array|string|null $body = null, int $status = 200, array<string, mixed> $headers = [])
Create a new PSR-7 response instance for use during stubbing.
static protected array
normalizeResponseHeaders(array $headers)
Normalize the given fake response headers.
static protected string
normalizeScalarString(scalar $value)
Normalize a scalar to a string without triggering PHP 8.5 non-finite float warnings.
static RequestException
failedRequest(array|string|null $body = null, int $status = 200, array<string, mixed> $headers = [])
Create a new RequestException instance for use during stubbing.
static PromiseInterface
failedConnection(string|null $message = null)
Create a new connection exception for use during stubbing.
ResponseSequence
sequence(array $responses = [])
Get an invokable object that returns a sequence of responses in order for use during stubbing.
$this
fake(callable|array<string, mixed>|null $callback = null)
Register a stub callable that will intercept requests and be able to return stub responses.
ResponseSequence
fakeSequence(string $url = '*')
Register a response sequence for the given URL pattern.
$this
stubUrl(string $url, Response|PromiseInterface|callable|int|string|array|ResponseSequence $callback)
Stub the given URL using the given callback.
$this
preventStrayRequests(bool $prevent = true)
Indicate that an exception should be thrown if any request is not faked.
bool
preventingStrayRequests()
Determine if stray requests are being prevented.
$this
allowStrayRequests(array|null $only = null)
Allow stray, unfaked requests entirely, or optionally allow only specific URLs.
$this
record()
Begin recording request / response pairs.
void
recordRequestResponsePair(Request $request, Response|null $response)
Record a request response pair.
void
assertSent(callable|Response|null): bool $callback)
Assert that a request / response pair was recorded matching a given truth test.
void
assertSentInOrder(list<string|Response|null): bool|callable> $callbacks)
Assert that the given request was sent in the given order.
void
assertNotSent(callable|Response|null): bool $callback)
Assert that a request / response pair was not recorded matching a given truth test.
void
assertNothingSent()
Assert that no request / response pair was recorded.
void
assertSentCount(int $count)
Assert how many requests have been recorded.
void
assertSequencesAreEmpty()
Assert that every created response sequence is empty.
Response|null}>
recorded(Response|null): bool|callable $callback = null)
Get a collection of the request / response pairs matching the given truth test.
PendingRequest
createPendingRequest()
Create a new pending request instance for this factory.
protected PendingRequest
newPendingRequest()
Instantiate a new pending request instance for this factory.
Dispatcher|null
getDispatcher()
Get the current event dispatcher implementation.
array
getGlobalMiddleware()
Get the array of global middleware.
Laravel Cloud is the best place to deploy Laravel, Nuxt, Express, Hono, Node.js, Bun, Go, Flask, Python, and more, with dedicated infrastructure available on AWS through Laravel Private Cloud.