HandlesRoutes
trait HandlesRoutes
Traits
Properties
| static protected array<class-string, array<class-string, class-string>> | $cachedTestCaseUses | Cached traits used by each test case class. |
from InteractsWithTestCase |
| static protected array<int, array{key: class-string, instance: object}> | $testCaseTestingFeatures | Programmatically added class-level testing features. |
from InteractsWithTestCase |
| static protected array<int, array{key: class-string, instance: object}> | $testCaseMethodTestingFeatures | Programmatically added method-level testing features. |
from InteractsWithTestCase |
| protected null|Closure): void | $testCaseSetUpCallback | The cached test case setUp resolver. |
from InteractsWithPHPUnit |
| protected null|Closure): void | $testCaseTearDownCallback | The cached test case tearDown resolver. |
from InteractsWithPHPUnit |
| static protected array<string, array<int, array{key: class-string, instance: object}>> | $cachedTestCaseClassAttributes | Cached class attributes by class name. |
from InteractsWithPHPUnit |
| static protected array<string, array<int, array{key: class-string, instance: object}>> | $cachedTestCaseMethodAttributes | Cached method attributes by "class:method" key. |
from InteractsWithPHPUnit |
| null|Application | $app | from InteractsWithPHPUnit | |
| protected bool | $syncTestbenchRoutesHasRun | Whether Testbench routes have been synchronized for this test. |
|
| protected bool | $testbenchRouteCleanupRegistered | Whether route file cleanup has been registered for this test. |
|
| protected bool | $reloadingApplicationForCachedRoutes | Whether defineCacheRoutes() is reloading the application to load cached routes. |
|
| protected array<int, string> | $testbenchRouteFiles | Route files written by this test instance. |
Methods
Determine if the test case uses the given trait, or the Testing trait by default.
Determine if the test case uses refresh-database testing concerns.
Cache and return traits used by test case.
Programmatically add a testing feature attribute.
Resolve PHPUnit method attributes for specific method.
Execute BeforeEach lifecycle attributes.
Execute AfterEach lifecycle attributes.
Load test fixtures and execute BeforeAll lifecycle attributes.
Execute AfterAll lifecycle attributes and clear caches.
Determine if the object is running as a PHPUnit test case.
Resolve the PHPUnit test class name.
Resolve the PHPUnit test method name.
Resolve and cache PHPUnit attributes for current test.
Cache uses for test case before class runs.
Clear PHPUnit caches after class teardown.
Synchronize Testbench routes.
Register cleanup for route files and route cache written by this test.
Get a route file path owned by this test instance.
Details
in
InteractsWithTestCase at line 54
static bool
usesTestingConcern(string|null $trait = null)
Determine if the test case uses the given trait, or the Testing trait by default.
in
InteractsWithTestCase at line 62
static bool
usesRefreshDatabaseTestingConcern()
Determine if the test case uses refresh-database testing concerns.
in
InteractsWithTestCase at line 75
static array
cachedUsesForTestCase()
| internal |
Cache and return traits used by test case.
in
InteractsWithTestCase at line 89
static void
usesTestingFeature(object $attribute, int $flag = Attribute::TARGET_CLASS)
Programmatically add a testing feature attribute.
in
InteractsWithTestCase at line 120
abstract static protected Collection
resolvePhpUnitAttributesForMethod(string $className, string|null $methodName = null)
Resolve PHPUnit method attributes for specific method.
in
InteractsWithTestCase at line 127
protected void
setUpTheTestEnvironmentUsingTestCase()
| internal |
Execute BeforeEach lifecycle attributes.
in
InteractsWithTestCase at line 142
protected void
tearDownTheTestEnvironmentUsingTestCase()
| internal |
Execute AfterEach lifecycle attributes.
in
InteractsWithTestCase at line 178
static void
setUpBeforeClassUsingTestCase()
| internal |
Load test fixtures and execute BeforeAll lifecycle attributes.
in
InteractsWithTestCase at line 195
static void
tearDownAfterClassUsingTestCase()
| internal |
Execute AfterAll lifecycle attributes and clear caches.
in
InteractsWithPHPUnit at line 56
bool
isRunningTestCase()
Determine if the object is running as a PHPUnit test case.
in
InteractsWithPHPUnit at line 68
string|null
resolvePhpUnitTestClassName()
| internal |
Resolve the PHPUnit test class name.
in
InteractsWithPHPUnit at line 84
string|null
resolvePhpUnitTestMethodName()
| internal |
Resolve the PHPUnit test method name.
in
InteractsWithPHPUnit at line 100
protected Collection
resolvePhpUnitAttributes()
| internal |
Resolve and cache PHPUnit attributes for current test.
in
InteractsWithPHPUnit at line 146
void
setUpTheEnvironmentUsing(Closure $setUp)
| internal |
Define the setUp environment using callback.
in
InteractsWithPHPUnit at line 158
void
tearDownTheEnvironmentUsing(Closure $tearDown)
| internal |
Define the tearDown environment using callback.
in
InteractsWithPHPUnit at line 168
static void
setUpBeforeClassUsingPHPUnit()
| internal |
Cache uses for test case before class runs.
in
InteractsWithPHPUnit at line 178
static void
tearDownAfterClassUsingPHPUnit()
| internal |
Clear PHPUnit caches after class teardown.
at line 60
protected void
setUpApplicationRoutes(Application $app)
| internal |
Setup application routes.
at line 87
protected void
defineRoutes(Router $router)
Define routes setup.
at line 97
protected void
defineWebRoutes(Router $router)
Define web routes setup.
at line 107
protected void
defineStashRoutes(Closure|string $route)
Define stash routes setup.
at line 117
protected void
defineCacheRoutes(Closure|string $route, bool $cached = true)
Define cache routes setup.
at line 194
protected void
syncTestbenchRoutes()
| internal |
Synchronize Testbench routes.
at line 213
protected void
registerTestbenchRouteCleanup(Filesystem $files, string $cachedRoutesPath)
Register cleanup for route files and route cache written by this test.
at line 266
protected string
testbenchRouteFilePath(string $basePath)
Get a route file path owned by this test instance.