class Application

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
protected Application|null $app

The Hypervel application instance.

protected string|false|null $applicationBootstrapFile

The resolved application bootstrap file.

from  WithHypervelBootstrapFile
protected array{env: array<int, string>, providers: array<int, class-string>, dont-discover: array<int, string>, bootstrappers: null|array<int, class-string>|class-string} $config

List of configurations.

protected null|Application): void $resolvingCallback

The application resolving callback.

protected bool $loadEnvironmentVariables

Load environment variables from disk.

Methods

void
configureParallelDatabaseName(mixed $app)

Rewrite the default connection's database name for parallel testing.

void
ensureParallelDatabaseExists()

Ensure the per-worker database exists, creating it if needed.

bool
shouldManageParallelDatabase(mixed $driver, string $database)

Determine if the database should be managed for parallel testing.

string
parallelTestDatabase(string $database, string $token)

Get the per-worker test database name.

static bool
usesTestingConcern(string|null $trait = null)

Check if the test case uses a specific trait.

static bool
usesRefreshDatabaseTestingConcern()

Determine if the test case uses refresh-database testing concerns.

static array
cachedUsesForTestCase()

Cache and return traits used by test case.

static void
usesTestingFeature(object $attribute, int $flag = Attribute::TARGET_CLASS)

Programmatically add a testing feature attribute.

static Collection
resolvePhpUnitAttributesForMethod(string $className, string|null $methodName = null)

Resolve PHPUnit method attributes for specific method.

void
setUpTheTestEnvironmentUsingTestCase()

Execute BeforeEach lifecycle attributes.

void
tearDownTheTestEnvironmentUsingTestCase()

Execute AfterEach lifecycle attributes.

static void
setUpBeforeClassUsingTestCase()

Execute BeforeAll lifecycle attributes.

static void
tearDownAfterClassUsingTestCase()

Execute AfterAll lifecycle attributes and clear caches.

bool
isRunningTestCase()

Determine if the container is running as a TestCase.

string|null
resolvePhpUnitTestClassName()

Resolve the PHPUnit test class name.

string|null
resolvePhpUnitTestMethodName()

Resolve the PHPUnit test method name.

resolvePhpUnitAttributes()

Resolve and cache PHPUnit attributes for current test.

void
setUpTheEnvironmentUsing(Closure $setUp)

Define the setUp environment using callback.

void
tearDownTheEnvironmentUsing(Closure $tearDown)

Define the tearDown environment using callback.

static void
setUpBeforeClassUsingPHPUnit()

Cache uses for test case before class runs.

static void
tearDownAfterClassUsingPHPUnit()

Clear PHPUnit caches after class teardown.

bool
isRunningTestCaseUsingPest()

Determine if the trait is used within testing using Pest.

static bool
isRunningViaPestPrinter(object|string $object)

Determine if the object implements Pest test runner.

static string|null
applicationBasePathUsingWorkbench()

Get Application's base path.

array|null
ignorePackageDiscoveriesFromUsingWorkbench()

Ignore package discovery from.

array|null
getPackageBootstrappersUsingWorkbench(object $app)

Get package bootstrapper.

array|null
getPackageProvidersUsingWorkbench(object $app)

Get package providers.

string
applicationConsoleKernelUsingWorkbench(object $app)

Resolve application Console Kernel implementation.

string
applicationHttpKernelUsingWorkbench(object $app)

Get application HTTP Kernel implementation using Workbench.

string
applicationExceptionHandlerUsingWorkbench(object $app)

Get application HTTP exception handler using Workbench.

static Config|null
cachedConfigurationForWorkbench()

Define or get the cached uses for test case.

string|false
getApplicationBootstrapFile(string $filename)

Get application bootstrap file path (if exists).

bool
hasCustomApplicationKernels()

Determine if application is using a custom application kernels.

bool
usesTestbenchDefaultSkeleton()

Determine if application is bootstrapped using Testbench's default skeleton.

string
getApplicationBasePath()

Resolve the application's base path.

static string
applicationBasePath()

Get the base path for the application.

array
ignorePackageDiscoveriesFrom()

Ignore package discovery from.

array
getPackageProviders(Application $app)

Get the package providers.

array
getPackageBootstrappers(Application $app)

Get the package bootstrappers.

array
getApplicationProviders(Application $app)

Get application providers.

string|null
getApplicationTimezone(Application $app)

Get the application timezone.

array
overrideApplicationProviders(Application $app)

Override application providers.

array
getPackageAliases(Application $app)

Get package aliases.

array
overrideApplicationBindings(Application $app)

Override application bindings.

void
defineEnvironment(Application $app)

Define environment setup.

createApplication()

Create the application instance.

resolveApplication()

Resolve the application instance.

void
resolveApplicationBindings(Application $app)

Resolve application bindings.

void
resolveApplicationExceptionHandler(Application $app)

Resolve application HTTP exception handler.

void
resolveApplicationCore(Application $app)

Resolve application core environment.

void
resolveApplicationEnvironmentVariables(Application $app)

Resolve application core environment variables implementation.

maskInheritedApplicationEnvironment()

Mask inherited framework APP_ENV for Testbench applications that opt out of loading env files.

bool
hasConfiguredApplicationEnvironmentVariable(string $key)

Determine if the current test explicitly configured an environment variable.

void
resolveApplicationHttpKernel(Application $app)

Resolve application HTTP kernel implementation.

void
resolveApplicationHttpMiddlewares(Application $app)

Resolve application HTTP default middlewares.

void
resolveApplicationConsoleKernel(Application $app)

Resolve application console kernel implementation.

void
resolveApplicationConfiguration(Application $app)

Load configuration and register package providers/aliases.

void
resolveApplicationProviders(Application $app)

Resolve the final application provider list.

void
resolveApplicationBootstrappers(Application $app)

Run bootstrappers individually with defineEnvironment() inserted.

void
refreshApplicationRouteNameLookups(Application $app)

Refresh route name lookups now and whenever the URL generator is resolved.

void
registerPackageAliases(Application $app)

Register package aliases into config.

void
configureParallelCachePaths()

Configure worker-specific cache paths for parallel testing.

string|null
paraTestWorkerToken()

Get the current ParaTest worker token before the application exists.

static Throwable|null
terminateAndFlushApplication(Application $app)

Terminate and flush an application, preserving the first cleanup failure.

__construct(string|null $basePath = null, callable|null $resolvingCallback = null)

Create a new application resolver.

static Application
make(string|null $basePath = null, callable|null $resolvingCallback = null, array $options = [])

Create a new application resolver.

static Application
makeFromConfig(Config $config, callable|null $resolvingCallback = null, array $options = [])

Create a new application resolver from configuration.

static Application
create(string|null $basePath = null, callable|null $resolvingCallback = null, array $options = [])

Create a new application instance.

static Application
createFromConfig(Config $config, callable|null $resolvingCallback = null, array $options = [])

Create a new application instance from configuration.

static Application
createVendorSymlink(string|null $basePath, string $workingVendorPath)

Create symlink to vendor path via new application instance.

static Application
deleteVendorSymlink(string|null $basePath)

Delete symlink to vendor path via new application instance.

configure(array $options)

Configure the application options.

maskInheritedStandaloneEnvironment()

Mask inherited framework APP_ENV for standalone Testbench apps.

bool
hasConfiguredEnvironmentVariable(string $key)

Determine if an environment variable was provided via Testbench config.

Details

protected void configureParallelDatabaseName(mixed $app)

Rewrite the default connection's database name for parallel testing.

Config-only — does not create connections or purge pools. Called early in CreatesApplication (after config is loaded, before defineEnvironment) so that custom connections derived from the default connection inherit the per-worker database name.

No-op when not running in parallel or when using in-memory SQLite.

Parameters

mixed $app

Return Value

void

protected void ensureParallelDatabaseExists()

Ensure the per-worker database exists, creating it if needed.

Called before Testbench database requirements and from database testing traits (RefreshDatabase, DatabaseMigrations, DatabaseTruncation, DatabaseTransactions) after the app is booted and connections are available. The config has already been rewritten by configureParallelDatabaseName().

No-op when not running in parallel or when using in-memory SQLite.

Return Value

void

protected bool shouldManageParallelDatabase(mixed $driver, string $database)

Determine if the database should be managed for parallel testing.

Parameters

mixed $driver
string $database

Return Value

bool

protected string parallelTestDatabase(string $database, string $token)

Get the per-worker test database name.

Parameters

string $database
string $token

Return Value

string

static bool usesTestingConcern(string|null $trait = null)

Check if the test case uses a specific trait.

Parameters

string|null $trait

Return Value

bool

static bool usesRefreshDatabaseTestingConcern()

Determine if the test case uses refresh-database testing concerns.

Return Value

bool

static array cachedUsesForTestCase()

Cache and return traits used by test case.

Return Value

array

static void usesTestingFeature(object $attribute, int $flag = Attribute::TARGET_CLASS)

Programmatically add a testing feature attribute.

Parameters

object $attribute
int $flag

Return Value

void

abstract static protected Collection resolvePhpUnitAttributesForMethod(string $className, string|null $methodName = null)

Resolve PHPUnit method attributes for specific method.

Parameters

string $className
string|null $methodName

Return Value

Collection

protected void setUpTheTestEnvironmentUsingTestCase()

Execute BeforeEach lifecycle attributes.

Return Value

void

protected void tearDownTheTestEnvironmentUsingTestCase()

Execute AfterEach lifecycle attributes.

Return Value

void

static void setUpBeforeClassUsingTestCase()

Execute BeforeAll lifecycle attributes.

Return Value

void

static void tearDownAfterClassUsingTestCase()

Execute AfterAll lifecycle attributes and clear caches.

Return Value

void

at line 190
bool isRunningTestCase()

Determine if the container is running as a TestCase.

Return Value

bool

string|null resolvePhpUnitTestClassName()

Resolve the PHPUnit test class name.

Return Value

string|null

string|null resolvePhpUnitTestMethodName()

Resolve the PHPUnit test method name.

Return Value

string|null

protected Collection resolvePhpUnitAttributes()

Resolve and cache PHPUnit attributes for current test.

Return Value

Collection

in InteractsWithPHPUnit at line 135
void setUpTheEnvironmentUsing(Closure $setUp)

Define the setUp environment using callback.

Parameters

Closure $setUp

Return Value

void

in InteractsWithPHPUnit at line 145
void tearDownTheEnvironmentUsing(Closure $tearDown)

Define the tearDown environment using callback.

Parameters

Closure $tearDown

Return Value

void

in InteractsWithPHPUnit at line 153
static void setUpBeforeClassUsingPHPUnit()

Cache uses for test case before class runs.

Return Value

void

in InteractsWithPHPUnit at line 161
static void tearDownAfterClassUsingPHPUnit()

Clear PHPUnit caches after class teardown.

Return Value

void

in InteractsWithPest at line 17
bool isRunningTestCaseUsingPest()

Determine if the trait is used within testing using Pest.

Return Value

bool

in InteractsWithPest at line 25
static protected bool isRunningViaPestPrinter(object|string $object)

Determine if the object implements Pest test runner.

Parameters

object|string $object

Return Value

bool

static string|null applicationBasePathUsingWorkbench()

internal  
 

Get Application's base path.

Return Value

string|null

array|null ignorePackageDiscoveriesFromUsingWorkbench()

internal  
 

Ignore package discovery from.

Return Value

array|null

protected array|null getPackageBootstrappersUsingWorkbench(object $app)

internal  
 

Get package bootstrapper.

Parameters

object $app

Return Value

array|null

protected array|null getPackageProvidersUsingWorkbench(object $app)

internal  
 

Get package providers.

Parameters

object $app

Return Value

array|null

protected string applicationConsoleKernelUsingWorkbench(object $app)

internal  
 

Resolve application Console Kernel implementation.

Parameters

object $app

Return Value

string

protected string applicationHttpKernelUsingWorkbench(object $app)

internal  
 

Get application HTTP Kernel implementation using Workbench.

Parameters

object $app

Return Value

string

protected string applicationExceptionHandlerUsingWorkbench(object $app)

internal  
 

Get application HTTP exception handler using Workbench.

Parameters

object $app

Return Value

string

static Config|null cachedConfigurationForWorkbench()

Define or get the cached uses for test case.

Return Value

Config|null

protected string|false getApplicationBootstrapFile(string $filename)

internal  
 

Get application bootstrap file path (if exists).

Parameters

string $filename

Return Value

string|false

protected bool hasCustomApplicationKernels()

internal  
 

Determine if application is using a custom application kernels.

Return Value

bool

protected bool usesTestbenchDefaultSkeleton()

Determine if application is bootstrapped using Testbench's default skeleton.

Return Value

bool

at line 335
protected string getApplicationBasePath()

Resolve the application's base path.

Return Value

string

in CreatesApplication at line 68
static string applicationBasePath()

Get the base path for the application.

Return Value

string

at line 200
array ignorePackageDiscoveriesFrom()

Ignore package discovery from.

Return Value

array

at line 311
protected array getPackageProviders(Application $app)

Get the package providers.

Parameters

Application $app

Return Value

array

at line 321
protected array getPackageBootstrappers(Application $app)

Get the package bootstrappers.

Parameters

Application $app

Return Value

array

in CreatesApplication at line 119
protected array getApplicationProviders(Application $app)

Get application providers.

Override in test classes to filter the default provider list before registration. For example, to remove SessionServiceProvider.

Parameters

Application $app

Return Value

array

in CreatesApplication at line 127
protected string|null getApplicationTimezone(Application $app)

Get the application timezone.

Parameters

Application $app

Return Value

string|null

in CreatesApplication at line 140
protected array overrideApplicationProviders(Application $app)

Override application providers.

Return a map of provider class names to replacements. Set a provider to false to remove it entirely, or to another class name to replace it.

Parameters

Application $app

Return Value

array

in CreatesApplication at line 150
protected array getPackageAliases(Application $app)

Get package aliases.

Parameters

Application $app

Return Value

array

in CreatesApplication at line 160
protected array overrideApplicationBindings(Application $app)

Override application bindings.

Parameters

Application $app

Return Value

array

in CreatesApplication at line 171
protected void defineEnvironment(Application $app)

Define environment setup.

Override in subclasses to modify config before providers boot. This is where test classes set database drivers, cache stores, etc.

Parameters

Application $app

Return Value

void

at line 208
Application createApplication()

Create the application instance.

Return Value

Application

in CreatesApplication at line 236
protected Application resolveApplication()

Resolve the application instance.

Return Value

Application

in CreatesApplication at line 258
protected void resolveApplicationBindings(Application $app)

Resolve application bindings.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 268
protected void resolveApplicationExceptionHandler(Application $app)

Resolve application HTTP exception handler.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 276
protected void resolveApplicationCore(Application $app)

Resolve application core environment.

Parameters

Application $app

Return Value

void

at line 343
protected void resolveApplicationEnvironmentVariables(Application $app)

Resolve application core environment variables implementation.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 327
protected Closure maskInheritedApplicationEnvironment()

Mask inherited framework APP_ENV for Testbench applications that opt out of loading env files.

The framework suite forces APP_ENV=testing globally via phpunit.xml.dist. Tests that disable environment loading should instead use the configuration defaults unless they explicitly provided APP_ENV or package-tester mode is enabled.

Return Value

Closure

in CreatesApplication at line 368
protected bool hasConfiguredApplicationEnvironmentVariable(string $key)

Determine if the current test explicitly configured an environment variable.

Parameters

string $key

Return Value

bool

at line 382
protected void resolveApplicationHttpKernel(Application $app)

Resolve application HTTP kernel implementation.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 388
protected void resolveApplicationHttpMiddlewares(Application $app)

Resolve application HTTP default middlewares.

Parameters

Application $app

Return Value

void

at line 370
protected void resolveApplicationConsoleKernel(Application $app)

Resolve application console kernel implementation.

Parameters

Application $app

Return Value

void

at line 361
protected void resolveApplicationConfiguration(Application $app)

Load configuration and register package providers/aliases.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 481
protected void resolveApplicationProviders(Application $app)

Resolve the final application provider list.

Merges package providers, then applies overrides (replacements/removals) before writing the final list to config for RegisterProviders to use.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 511
protected void resolveApplicationBootstrappers(Application $app)

Run bootstrappers individually with defineEnvironment() inserted.

Equivalent to Orchestral's resolveApplicationBootstrappers().

Parameters

Application $app

Return Value

void

in CreatesApplication at line 571
protected void refreshApplicationRouteNameLookups(Application $app)

Refresh route name lookups now and whenever the URL generator is resolved.

Route names set via fluent ->name() after RouteCollection::add() are not indexed until refreshNameLookups() rebuilds the lookup table. This method ensures names are refreshed both immediately and lazily — the after_resolving callback catches routes defined inside test methods (after boot) by firing whenever app('url') is resolved.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 586
protected void registerPackageAliases(Application $app)

Register package aliases into config.

Parameters

Application $app

Return Value

void

in CreatesApplication at line 607
protected void configureParallelCachePaths()

Configure worker-specific cache paths for parallel testing.

When running under ParaTest, each worker gets a unique route cache path to prevent filesystem races. Without this, one worker's defineCacheRoutes() writes a shared cache file that causes other workers' routesAreCached() to return true, skipping route setup.

Return Value

void

in CreatesApplication at line 625
protected string|null paraTestWorkerToken()

Get the current ParaTest worker token before the application exists.

This reads the raw runtime arrays because cached route setup may run before parent::setUp(), when no application or ParallelTesting service has been created yet.

Return Value

string|null

in CreatesApplication at line 633
static protected Throwable|null terminateAndFlushApplication(Application $app)

Terminate and flush an application, preserving the first cleanup failure.

Parameters

Application $app

Return Value

Throwable|null

at line 65
__construct(string|null $basePath = null, callable|null $resolvingCallback = null)

Create a new application resolver.

Parameters

string|null $basePath
callable|null $resolvingCallback

at line 78
static Application make(string|null $basePath = null, callable|null $resolvingCallback = null, array $options = [])

Create a new application resolver.

Parameters

string|null $basePath
callable|null $resolvingCallback
array $options

Return Value

Application

at line 89
static Application makeFromConfig(Config $config, callable|null $resolvingCallback = null, array $options = [])

Create a new application resolver from configuration.

Parameters

Config $config
callable|null $resolvingCallback
array $options

Return Value

Application

at line 105
static Application create(string|null $basePath = null, callable|null $resolvingCallback = null, array $options = [])

Create a new application instance.

Parameters

string|null $basePath
callable|null $resolvingCallback
array $options

Return Value

Application

at line 116
static Application createFromConfig(Config $config, callable|null $resolvingCallback = null, array $options = [])

Create a new application instance from configuration.

Parameters

Config $config
callable|null $resolvingCallback
array $options

Return Value

Application

Create symlink to vendor path via new application instance.

Parameters

string|null $basePath
string $workingVendorPath

Return Value

Application

Delete symlink to vendor path via new application instance.

Parameters

string|null $basePath

Return Value

Application

at line 167
Application configure(array $options)

Configure the application options.

Parameters

array $options

Return Value

Application

at line 246
protected Closure maskInheritedStandaloneEnvironment()

Mask inherited framework APP_ENV for standalone Testbench apps.

The framework suite forces APP_ENV=testing globally via phpunit.xml.dist. Standalone Testbench applications should instead use the workbench config default unless the caller explicitly supplied APP_ENV or requested on-disk environment loading.

Return Value

Closure

at line 291
protected bool hasConfiguredEnvironmentVariable(string $key)

Determine if an environment variable was provided via Testbench config.

Parameters

string $key

Return Value

bool