class TestResponse implements ArrayAccess (View source)
| Tappable | |
| Macroable |
| static protected array | $macros | The registered string macros. | from Macroable |
| Response | $baseResponse | The response to delegate to. | |
| protected string | $streamedContent | The streamed content of the response. |
| mixed | tap(callable|null $callback = null) Call the given Closure with this instance then return the instance. | from Tappable |
| static void | macro(string $name, object|callable $macro) Register a custom macro. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true) Mix another object into the class. | from Macroable |
| static bool | hasMacro(string $name) Checks if macro is registered. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Dynamically handle calls to the class. | from Macroable |
| mixed | __call(string $method, array $args) Handle dynamic calls into macros or pass missing methods to the base response. | |
| void | __construct(Response $response) Create a new test response instance. | |
| static TestResponse | fromBaseResponse(Response $response) Create a new TestResponse from another response. | |
| $this | assertSuccessful() Assert that the response has a successful status code. | |
| $this | assertOk() Assert that the response has a 200 status code. | |
| $this | assertCreated() Assert that the response has a 201 status code. | |
| $this | assertNoContent(int $status = 204) Assert that the response has the given status code and no content. | |
| $this | assertNotFound() Assert that the response has a not found status code. | |
| $this | assertForbidden() Assert that the response has a forbidden status code. | |
| $this | assertUnauthorized() Assert that the response has an unauthorized status code. | |
| $this | assertStatus(int $status) Assert that the response has the given status code. | |
| $this | assertRedirect(string|null $uri = null) Assert whether the response is redirecting to a given URI. | |
| $this | assertHeader(string $headerName, mixed $value = null) Asserts that the response contains the given header and equals the optional value. | |
| $this | assertHeaderMissing(string $headerName) Asserts that the response does not contains the given header. | |
| $this | assertLocation(string $uri) Assert that the current location header matches the given URI. | |
| $this | assertPlainCookie(string $cookieName, mixed $value = null) Asserts that the response contains the given cookie and equals the optional value. | |
| $this | assertCookie(string $cookieName, mixed $value = null, bool $encrypted = true, bool $unserialize = false) Asserts that the response contains the given cookie and equals the optional value. | |
| $this | assertCookieExpired(string $cookieName) Asserts that the response contains the given cookie and is expired. | |
| $this | assertCookieNotExpired(string $cookieName) Asserts that the response contains the given cookie and is not expired. | |
| $this | assertCookieMissing(string $cookieName) Asserts that the response does not contains the given cookie. | |
| Cookie|null | getCookie(string $cookieName) Get the given cookie from the response. | |
| $this | assertSee(string|array $value, bool $escape = true) Assert that the given string or array of strings are contained within the response. | |
| $this | assertSeeInOrder(array $values, bool $escape = true) Assert that the given strings are contained in order within the response. | |
| $this | assertSeeText(string|array $value, bool $escape = true) Assert that the given string or array of strings are contained within the response text. | |
| $this | assertSeeTextInOrder(array $values, bool $escape = true) Assert that the given strings are contained in order within the response text. | |
| $this | assertDontSee(string|array $value, bool $escape = true) Assert that the given string or array of strings are not contained within the response. | |
| $this | assertDontSeeText(string|array $value, bool $escape = true) Assert that the given string or array of strings are not contained within the response text. | |
| $this | assertJson(array $data, bool $strict = false) Assert that the response is a superset of the given JSON. | |
| $this | assertJsonPath(string $path, mixed $expect) Assert that the expected value and type exists at the given path in the response. | |
| $this | assertExactJson(array $data) Assert that the response has the exact given JSON. | |
| $this | assertSimilarJson(array $data) Assert that the response has the similar JSON as given. | |
| $this | assertJsonFragment(array $data) Assert that the response contains the given JSON fragment. | |
| $this | assertJsonMissing(array $data, bool $exact = false) Assert that the response does not contain the given JSON fragment. | |
| $this | assertJsonMissingExact(array $data) Assert that the response does not contain the exact JSON fragment. | |
| $this | assertJsonStructure(array $structure = null, array|null $responseData = null) Assert that the response has a given JSON structure. | |
| $this | assertJsonCount(int $count, string|null $key = null) Assert that the response JSON has the expected count of items at the given key. | |
| $this | assertJsonValidationErrors(string|array $errors, string $responseKey = 'errors') Assert that the response has the given JSON validation errors. | |
| $this | assertJsonMissingValidationErrors(string|array|null $keys = null, string $responseKey = 'errors') Assert that the response has no JSON validation errors for the given keys. | |
| AssertableJsonString | decodeResponseJson() Validate and return the decoded response JSON. | |
| mixed | json(string|null $key = null) Validate and return the decoded response JSON. | |
| $this | assertViewIs(string $value) Assert that the response view equals the given value. | |
| $this | assertViewHas(string|array $key, mixed $value = null) Assert that the response view has a given piece of bound data. | |
| $this | assertViewHasAll(array $bindings) Assert that the response view has a given list of bound data. | |
| mixed | viewData(string $key) Get a piece of data from the original view. | |
| $this | assertViewMissing(string $key) Assert that the response view is missing a piece of bound data. | |
| $this | ensureResponseHasView() Ensure that the response has a view as its original content. | |
| bool | responseHasView() Determine if the original response is a view. | |
| $this | assertSessionHas(string|array $key, mixed $value = null) Assert that the session has a given value. | |
| $this | assertSessionHasAll(array $bindings) Assert that the session has a given list of values. | |
| $this | assertSessionHasInput(string|array $key, mixed $value = null) Assert that the session has a given value in the flashed input array. | |
| $this | assertSessionHasErrors(string|array $keys = [], mixed $format = null, string $errorBag = 'default') Assert that the session has the given errors. | |
| $this | assertSessionDoesntHaveErrors(string|array $keys = [], string|null $format = null, string $errorBag = 'default') Assert that the session is missing the given errors. | |
| $this | assertSessionHasNoErrors() Assert that the session has no errors. | |
| $this | assertSessionHasErrorsIn(string $errorBag, string|array $keys = [], mixed $format = null) Assert that the session has the given errors. | |
| $this | assertSessionMissing(string|array $key) Assert that the session does not have a given key. | |
| Store | session() Get the current session store. | |
| $this | dump() Dump the content from the response. | |
| $this | dumpHeaders() Dump the headers from the response. | |
| $this | dumpSession(string|array $keys = []) Dump the session from the response. | |
| string | streamedContent() Get the streamed content from the response. | |
| mixed | __get(string $key) Dynamically access base response parameters. | |
| mixed | __isset(string $key) Proxy isset() checks to the underlying base response. | |
| bool | offsetExists(string $offset) Determine if the given offset exists. | |
| mixed | offsetGet(string $offset) Get the value for a given offset. | |
| void | offsetSet(string $offset, mixed $value) Set the value at the given offset. | |
| void | offsetUnset(string $offset) Unset the value at the given offset. |
Call the given Closure with this instance then return the instance.
Register a custom macro.
Mix another object into the class.
Checks if macro is registered.
Dynamically handle calls to the class.
Handle dynamic calls into macros or pass missing methods to the base response.
Create a new test response instance.
Create a new TestResponse from another response.
Assert that the response has a successful status code.
Assert that the response has a 200 status code.
Assert that the response has a 201 status code.
Assert that the response has the given status code and no content.
Assert that the response has a not found status code.
Assert that the response has a forbidden status code.
Assert that the response has an unauthorized status code.
Assert that the response has the given status code.
Assert whether the response is redirecting to a given URI.
Asserts that the response contains the given header and equals the optional value.
Asserts that the response does not contains the given header.
Assert that the current location header matches the given URI.
Asserts that the response contains the given cookie and equals the optional value.
Asserts that the response contains the given cookie and equals the optional value.
Asserts that the response contains the given cookie and is expired.
Asserts that the response contains the given cookie and is not expired.
Asserts that the response does not contains the given cookie.
Get the given cookie from the response.
Assert that the given string or array of strings are contained within the response.
Assert that the given strings are contained in order within the response.
Assert that the given string or array of strings are contained within the response text.
Assert that the given strings are contained in order within the response text.
Assert that the given string or array of strings are not contained within the response.
Assert that the given string or array of strings are not contained within the response text.
Assert that the response is a superset of the given JSON.
Assert that the expected value and type exists at the given path in the response.
Assert that the response has the exact given JSON.
Assert that the response has the similar JSON as given.
Assert that the response contains the given JSON fragment.
Assert that the response does not contain the given JSON fragment.
Assert that the response does not contain the exact JSON fragment.
Assert that the response has a given JSON structure.
Assert that the response JSON has the expected count of items at the given key.
Assert that the response has the given JSON validation errors.
Assert that the response has no JSON validation errors for the given keys.
Validate and return the decoded response JSON.
Validate and return the decoded response JSON.
Assert that the response view equals the given value.
Assert that the response view has a given piece of bound data.
Assert that the response view has a given list of bound data.
Get a piece of data from the original view.
Assert that the response view is missing a piece of bound data.
Ensure that the response has a view as its original content.
Determine if the original response is a view.
Assert that the session has a given value.
Assert that the session has a given list of values.
Assert that the session has a given value in the flashed input array.
Assert that the session has the given errors.
Assert that the session is missing the given errors.
Assert that the session has no errors.
Assert that the session has the given errors.
Assert that the session does not have a given key.
Get the current session store.
Dump the content from the response.
Dump the headers from the response.
Dump the session from the response.
Get the streamed content from the response.
Dynamically access base response parameters.
Proxy isset() checks to the underlying base response.
Determine if the given offset exists.
Get the value for a given offset.
Set the value at the given offset.
Unset the value at the given offset.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Testing/TestResponse.html