Factory
class Factory (View source)
Traits
Properties
| static protected array | $macros | The registered string macros. |
from Macroable |
| protected Collection | $stubCallbacks | The stub callables that will handle requests. |
|
| protected bool | $recording | Indicates if the factory is recording requests and responses. |
|
| protected array | $recorded | The recorded response array. |
|
| protected array | $responseSequences | All created response sequences. |
Methods
Mix another object into the class.
Dynamically handle calls to the class.
Execute a method against a new pending request instance.
Create a new factory instance.
Create a new response instance 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.
Begin recording request / response pairs.
Assert that a request / response pair was recorded matching a given truth test.
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.
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 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.
void
__construct()
Create a new factory instance.
static PromiseInterface
response(array|string $body = null, int $status = 200, array $headers = [])
Create a new response instance 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 $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 $callback)
Stub the given URL using the given callback.
protected $this
record()
Begin recording request / response pairs.
void
recordRequestResponsePair(Request $request, Response $response)
Record a request response pair.
void
assertSent(callable $callback)
Assert that a request / response pair was recorded matching a given truth test.
void
assertNotSent(callable $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.
Collection
recorded(callable $callback)
Get a collection of the request / response pairs matching the given truth test.