abstract class TestCase extends TestCase (View source)
| protected Vite|null | $originalVite | The original Vite handler. | from InteractsWithContainer |
| protected Mix|null | $originalMix | The original Laravel Mix handler. | from InteractsWithContainer |
| protected array | $defaultHeaders | Additional headers for the request. | from MakesHttpRequests |
| protected array | $defaultCookies | Additional cookies for the request. | from MakesHttpRequests |
| protected array | $unencryptedCookies | Additional cookies will not be encrypted for the request. | from MakesHttpRequests |
| protected array | $serverVariables | Additional server variables for the request. | from MakesHttpRequests |
| protected bool | $followRedirects | Indicates whether redirects should be followed. | from MakesHttpRequests |
| protected bool | $encryptCookies | Indicates whether cookies should be encrypted. | from MakesHttpRequests |
| protected bool | $withCredentials | Indicated whether JSON requests should be performed "with credentials" (cookies). | from MakesHttpRequests |
| bool | $mockConsoleOutput | Indicates if the console output should be mocked. | from InteractsWithConsole |
| bool|null | $expectsOutput | Indicates if the command is expected to output anything. | from InteractsWithConsole |
| array | $expectedOutput | All of the expected output lines. | from InteractsWithConsole |
| array | $expectedOutputSubstrings | All of the expected text to be present in the output. | from InteractsWithConsole |
| array | $unexpectedOutput | All of the output lines that aren't expected to be displayed. | from InteractsWithConsole |
| array | $unexpectedOutputSubstrings | All of the text that is not expected to be present in the output. | from InteractsWithConsole |
| array | $expectedTables | All of the expected output tables. | from InteractsWithConsole |
| array | $expectedQuestions | All of the expected questions. | from InteractsWithConsole |
| array | $expectedChoices | All of the expected choice questions. | from InteractsWithConsole |
| protected callable|null | $originalDeprecationHandler | The original deprecation handler. | from InteractsWithDeprecationHandling |
| protected ExceptionHandler|null | $originalExceptionHandler | The original exception handler. | from InteractsWithExceptionHandling |
| protected | $except | from InteractsWithExceptionHandling | |
| protected | $originalHandler | from InteractsWithExceptionHandling | |
| protected Application | $app | The Illuminate application instance. | from InteractsWithTestCaseLifecycle |
| protected array | $afterApplicationCreatedCallbacks | The callbacks that should be run after the application is created. | from InteractsWithTestCaseLifecycle |
| protected array | $beforeApplicationDestroyedCallbacks | The callbacks that should be run before the application is destroyed. | from InteractsWithTestCaseLifecycle |
| protected Throwable | $callbackException | The exception thrown while running an application destruction callback. | from InteractsWithTestCaseLifecycle |
| protected bool | $setUpHasRun | Indicates if we have made it through the base setUp function. | from InteractsWithTestCaseLifecycle |
| object | swap(string $abstract, object $instance)
Register an instance of an object in the container. | from InteractsWithContainer |
| object | instance(string $abstract, object $instance)
Register an instance of an object in the container. | from InteractsWithContainer |
| MockInterface | mock(string $abstract, Closure|null $mock = null)
Mock an instance of an object in the container. | from InteractsWithContainer |
| MockInterface | partialMock(string $abstract, Closure|null $mock = null)
Mock a partial instance of an object in the container. | from InteractsWithContainer |
| MockInterface | spy(string $abstract, Closure|null $mock = null)
Spy an instance of an object in the container. | from InteractsWithContainer |
| $this | forgetMock(string $abstract)
Instruct the container to forget a previously mocked / spied instance of an object. | from InteractsWithContainer |
| $this | withoutVite()
Register an empty handler for Vite in the container. | from InteractsWithContainer |
| __invoke($entrypoints, $buildDirectory = null) No description | from InteractsWithContainer | |
| __call($method, $parameters) No description | from InteractsWithContainer | |
| __toString() No description | from InteractsWithContainer | |
| useIntegrityKey($key) No description | from InteractsWithContainer | |
| useBuildDirectory($path) No description | from InteractsWithContainer | |
| useHotFile($path) No description | from InteractsWithContainer | |
| withEntryPoints($entryPoints) No description | from InteractsWithContainer | |
| useScriptTagAttributes($attributes) No description | from InteractsWithContainer | |
| useStyleTagAttributes($attributes) No description | from InteractsWithContainer | |
| usePreloadTagAttributes($attributes) No description | from InteractsWithContainer | |
| preloadedAssets() No description | from InteractsWithContainer | |
| reactRefresh() No description | from InteractsWithContainer | |
| content($asset, $buildDirectory = null) No description | from InteractsWithContainer | |
| asset($asset, $buildDirectory = null) No description | from InteractsWithContainer | |
| $this | withHeaders(array $headers)
Define additional headers to be sent with the request. | from MakesHttpRequests |
| $this | withHeader(string $name, string $value)
Add a header to be sent with the request. | from MakesHttpRequests |
| $this | withToken(string $token, string $type = 'Bearer')
Add an authorization token for the request. | from MakesHttpRequests |
| $this | withBasicAuth(string $username, string $password)
Add a basic authentication header to the request with the given credentials. | from MakesHttpRequests |
| $this | withoutToken()
Remove the authorization token from the request. | from MakesHttpRequests |
| $this | flushHeaders()
Flush all the configured headers. | from MakesHttpRequests |
| $this | withServerVariables(array $server)
Define a set of server variables to be sent with the requests. | from MakesHttpRequests |
| $this | withoutMiddleware(string|array|null $middleware = null)
Disable middleware for the test. | from MakesHttpRequests |
| handle($request, $next) No description | from MakesHttpRequests | |
| $this | actingAs(Authenticatable $user, string|null $guard = null)
Set the currently logged in user for the application. | from InteractsWithAuthentication |
| $this | be(Authenticatable $user, string|null $guard = null)
Set the currently logged in user for the application. | from InteractsWithAuthentication |
| $this | assertAuthenticated(string|null $guard = null)
Assert that the user is authenticated. | from InteractsWithAuthentication |
| $this | assertGuest(string|null $guard = null)
Assert that the user is not authenticated. | from InteractsWithAuthentication |
| bool | isAuthenticated(string|null $guard = null)
Return true if the user is authenticated, false otherwise. | from InteractsWithAuthentication |
| $this | assertAuthenticatedAs(Authenticatable $user, string|null $guard = null)
Assert that the user is authenticated as the given user. | from InteractsWithAuthentication |
| $this | assertCredentials(array $credentials, string|null $guard = null)
Assert that the given credentials are valid. | from InteractsWithAuthentication |
| $this | assertInvalidCredentials(array $credentials, string|null $guard = null)
Assert that the given credentials are invalid. | from InteractsWithAuthentication |
| bool | hasCredentials(array $credentials, string|null $guard = null)
Return true if the credentials are valid, false otherwise. | from InteractsWithAuthentication |
| PendingCommand|int | artisan(string $command, array $parameters = [])
Call artisan command and return code. | from InteractsWithConsole |
| $this | withoutMockingConsoleOutput()
Disable mocking the console output. | from InteractsWithConsole |
| $this | assertDatabaseHas(Model|string $table, array $data, string|null $connection = null)
Assert that a given where condition exists in the database. | from InteractsWithDatabase |
| $this | assertDatabaseMissing(Model|string $table, array $data, string|null $connection = null)
Assert that a given where condition does not exist in the database. | from InteractsWithDatabase |
| $this | assertDatabaseCount(Model|string $table, int $count, string|null $connection = null)
Assert the count of table entries. | from InteractsWithDatabase |
| $this | assertDatabaseEmpty(Model|string $table, string|null $connection = null)
Assert that the given table has no entries. | from InteractsWithDatabase |
| $this | assertSoftDeleted(Model|string $table, array $data = [], string|null $connection = null, string|null $deletedAtColumn = 'deleted_at')
Assert the given record has been "soft deleted". | from InteractsWithDatabase |
| $this | assertNotSoftDeleted(Model|string $table, array $data = [], string|null $connection = null, string|null $deletedAtColumn = 'deleted_at')
Assert the given record has not been "soft deleted". | from InteractsWithDatabase |
| $this | assertModelExists(Model $model)
Assert the given model exists in the database. | from InteractsWithDatabase |
| $this | assertModelMissing(Model $model)
Assert the given model does not exist in the database. | from InteractsWithDatabase |
| $this | expectsDatabaseQueryCount(int $expected, string|null $connection = null)
Specify the number of database queries that should occur throughout the test. | from InteractsWithDatabase |
| bool | isSoftDeletableModel(mixed $model)
Determine if the argument is a soft deletable model. | from InteractsWithDatabase |
| Expression | castAsJson(array|object|string $value)
Cast a JSON string to a database compatible type. | from InteractsWithDatabase |
| Connection | getConnection(string|null $connection = null, string|null $table = null)
Get the database connection. | from InteractsWithDatabase |
| string | getTable(Model|string $table)
Get the table name from the given model or string. | from InteractsWithDatabase |
| string|null | getTableConnection(Model|string $table)
Get the table connection specified in the given model. | from InteractsWithDatabase |
| string | getDeletedAtColumn(string $table, string $defaultColumnName = 'deleted_at')
Get the table column name used for soft deletes. | from InteractsWithDatabase |
| Model|null | newModelFor(Model|string $table)
Get the model entity from the given model or string. | from InteractsWithDatabase |
| $this | seed(array|string $class = 'Database\\Seeders\\DatabaseSeeder')
Seed a given database connection. | from InteractsWithDatabase |
| $this | withDeprecationHandling()
Restore deprecation handling. | from InteractsWithDeprecationHandling |
| $this | withoutDeprecationHandling()
Disable deprecation handling for the test. | from InteractsWithDeprecationHandling |
| $this | withExceptionHandling()
Restore exception handling. | from InteractsWithExceptionHandling |
| $this | handleExceptions(array $exceptions)
Only handle the given exceptions via the exception handler. | from InteractsWithExceptionHandling |
| $this | handleValidationExceptions()
Only handle validation exceptions via the exception handler. | from InteractsWithExceptionHandling |
| $this | withoutExceptionHandling(array $except = [])
Disable exception handling for the test. | from InteractsWithExceptionHandling |
| void | __construct(ExceptionHandler $originalHandler, array $except = [])
Create a new class instance. | from InteractsWithExceptionHandling |
| void | report(Throwable $e)
Report or log an exception. | from InteractsWithExceptionHandling |
| bool | shouldReport(Throwable $e)
Determine if the exception should be reported. | from InteractsWithExceptionHandling |
| Response | render(Request $request, Throwable $e)
Render an exception into an HTTP response. | from InteractsWithExceptionHandling |
| void | renderForConsole(OutputInterface $output, Throwable $e)
Render an exception to the console. | from InteractsWithExceptionHandling |
| $this | withSession(array $data)
Set the session to the given array. | from InteractsWithSession |
| $this | session(array $data)
Set the session to the given array. | from InteractsWithSession |
| $this | startSession()
Start the session for the application. | from InteractsWithSession |
| $this | flushSession()
Flush all of the current session data. | from InteractsWithSession |
| mixed | freezeTime(callable|null $callback = null)
Freeze time. | from InteractsWithTime |
| mixed | freezeSecond(callable|null $callback = null)
Freeze time at the beginning of the current second. | from InteractsWithTime |
| Wormhole | travel(int $value)
Begin travelling to another time. | from InteractsWithTime |
| mixed | travelTo(DateTimeInterface|Closure|Carbon|string|bool|null $date, callable|null $callback = null)
Travel to another time. | from InteractsWithTime |
| DateTimeInterface | travelBack()
Travel back to the current time. | from InteractsWithTime |
| void | setUpTheTestEnvironment()
Setup the test environment. | from InteractsWithTestCaseLifecycle |
| void | tearDownTheTestEnvironment()
Clean up the testing environment before the next test. | from InteractsWithTestCaseLifecycle |
| array | setUpTraits()
Boot the testing helper traits. | from InteractsWithTestCaseLifecycle |
| static void | tearDownAfterClassUsingTestCase()
Clean up the testing environment before the next test case. | from InteractsWithTestCaseLifecycle |
| void | afterApplicationCreated(callable $callback)
Register a callback to be run after the application is created. | from InteractsWithTestCaseLifecycle |
| void | beforeApplicationDestroyed(callable $callback)
Register a callback to be run before the application is destroyed. | from InteractsWithTestCaseLifecycle |
| void | callBeforeApplicationDestroyedCallbacks()
Execute the application's pre-destruction callbacks. | from InteractsWithTestCaseLifecycle |
| TestView | view(string $view, Arrayable|array $data = [])
Create a new TestView from the given view. | from InteractsWithViews |
| TestView | blade(string $template, Arrayable|array $data = [])
Render the contents of the given Blade template string. | from InteractsWithViews |
| TestComponent | component(string $componentClass, Arrayable|array $data = [])
Render the given view component. | from InteractsWithViews |
| $this | withViewErrors(array $errors, string $key = 'default')
Populate the shared view error bag with the given errors. | from InteractsWithViews |
| Application | createApplication()
Creates the application. | |
| void | setUp()
Setup the test environment. | |
| void | refreshApplication()
Refresh the application instance. | |
| void | tearDown()
Clean up the testing environment before the next test. | |
| static void | tearDownAfterClass()
Clean up the testing environment before the next test case. |
Register an instance of an object in the container.
Register an instance of an object in the container.
Mock an instance of an object in the container.
Mock a partial instance of an object in the container.
Spy an instance of an object in the container.
Instruct the container to forget a previously mocked / spied instance of an object.
Register an empty handler for Vite in the container.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
Define additional headers to be sent with the request.
Add a header to be sent with the request.
Add an authorization token for the request.
Add a basic authentication header to the request with the given credentials.
Remove the authorization token from the request.
Flush all the configured headers.
Define a set of server variables to be sent with the requests.
Disable middleware for the test.
No description
Set the currently logged in user for the application.
Set the currently logged in user for the application.
Assert that the user is authenticated.
Assert that the user is not authenticated.
Return true if the user is authenticated, false otherwise.
Assert that the user is authenticated as the given user.
Assert that the given credentials are valid.
Assert that the given credentials are invalid.
Return true if the credentials are valid, false otherwise.
Call artisan command and return code.
Disable mocking the console output.
Assert that a given where condition exists in the database.
Assert that a given where condition does not exist in the database.
Assert the count of table entries.
Assert that the given table has no entries.
Assert the given record has been "soft deleted".
Assert the given record has not been "soft deleted".
Assert the given model exists in the database.
Assert the given model does not exist in the database.
Specify the number of database queries that should occur throughout the test.
Determine if the argument is a soft deletable model.
Cast a JSON string to a database compatible type.
Get the database connection.
Get the table name from the given model or string.
Get the table connection specified in the given model.
Get the table column name used for soft deletes.
Get the model entity from the given model or string.
Seed a given database connection.
Restore deprecation handling.
Disable deprecation handling for the test.
Restore exception handling.
Only handle the given exceptions via the exception handler.
Only handle validation exceptions via the exception handler.
Disable exception handling for the test.
Create a new class instance.
Report or log an exception.
Determine if the exception should be reported.
Render an exception to the console.
Set the session to the given array.
Set the session to the given array.
Start the session for the application.
Flush all of the current session data.
Freeze time.
Freeze time at the beginning of the current second.
Begin travelling to another time.
Travel to another time.
Travel back to the current time.
| internal |
Setup the test environment.
| internal |
Clean up the testing environment before the next test.
Boot the testing helper traits.
| internal |
Clean up the testing environment before the next test case.
Register a callback to be run after the application is created.
Register a callback to be run before the application is destroyed.
Execute the application's pre-destruction callbacks.
Create a new TestView from the given view.
Render the contents of the given Blade template string.
Render the given view component.
Populate the shared view error bag with the given errors.
Creates the application.
Setup the test environment.
Refresh the application instance.
Clean up the testing environment before the next test.
Clean up the testing environment before the next test case.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Testing/TestCase.html