Skip to main content

UsagePagesGenerator

  • Full name: \Documentation\Generator\UsagePage\UsagePagesGenerator

Properties​

USAGE_DIR_PATH​

private static $USAGE_DIR_PATH
  • This property is static.

configuration​

private \Documentation\Generator\Configuration $configuration

testConfigs​

private \Documentation\Test\Config[] $testConfigs

Methods​

__construct​

public __construct(\Documentation\Generator\Configuration $configuration, array $testConfigs): mixed

Parameters:

ParameterTypeDescription
$configuration\Documentation\Generator\Configuration
$testConfigsarray

generate​

public generate(): mixed

cleanUsagePages​

private cleanUsagePages(): mixed

parseTestsConfig​

Extract test cases values for a given tests configuration

private parseTestsConfig(\Documentation\Test\Config $documentationTestConfig): mixed

Parameters:

ParameterTypeDescription
$documentationTestConfig\Documentation\Test\Config

getUsageDirPath​

private getUsageDirPath(): mixed

generateDocPageFromTest​

Write the test content for the given params into the given demo page file

private generateDocPageFromTest(\Documentation\Test\Config $documentationTestConfig): mixed

Parameters:

ParameterTypeDescription
$documentationTestConfig\Documentation\Test\Config