1. class
  2. StubTests
  3. \
  4. StubsStructureValidatorTest

StubsStructureValidatorTest

class StubsStructureValidatorTest extends TestCase (View source)

Validates the structural integrity of the stubs directory layout.

Ensures every top-level stubs directory is explicitly registered in StubCategory::getDirectories() so that new extension folders are never silently ignored by data providers and category-based filters.

Methods

static iterable
stubsDirectoryProvider()

Provides each top-level stubs directory as a separate test case.

void
checkStubsDirectoriesExistsInMap(string $directoryName)

Assert that every top-level stubs directory is present in StubCategory::getDirectories().

void
checkGenerateStubsMapScript()

Assert that tests/Framework/Tools/generate-stubs-map.php generates a valid PhpStormStubsMap to the project root when called without arguments.

void
checkStubMapIsUpToDate()

Assert that PhpStormStubsMap.php in the project root is up to date with the current stubs.

Details

at line 27
static iterable stubsDirectoryProvider()

Provides each top-level stubs directory as a separate test case.

Uses the active stubs provider so local reference material is not treated as stubs.

Return Value

iterable

at line 61
void checkStubsDirectoriesExistsInMap(string $directoryName)

Assert that every top-level stubs directory is present in StubCategory::getDirectories().

When a new extension directory is added to the stubs root it must also be registered in the appropriate StubCategory (CORE, BUNDLED, EXTERNAL, or PECL) so that category-based data providers include it correctly.

Parameters

string $directoryName

Top-level directory name (basename only, no path)

Return Value

void

at line 93
void checkGenerateStubsMapScript()

Assert that tests/Framework/Tools/generate-stubs-map.php generates a valid PhpStormStubsMap to the project root when called without arguments.

Verifies:

  1. The generator script exists.
  2. PhpStormStubsMap.php exists in the project root.
  3. The default output path baked into the script resolves to the project root.
  4. Running the script exits cleanly (exit code 0).
  5. The generated output has the expected PHP structure (namespace, class, array constants).
  6. All paths in the map are relative — no absolute filesystem paths.

Return Value

void

at line 157
void checkStubMapIsUpToDate()

Assert that PhpStormStubsMap.php in the project root is up to date with the current stubs.

Generates a fresh map into a temporary file using generate-stubs-map.php and compares its content byte-for-byte against the committed PhpStormStubsMap.php. Any discrepancy means a stub file was added, removed, or renamed without regenerating the map.

Fix: run php tests/Framework/Tools/generate-stubs-map.php from the project root.

Return Value

void