Skip to main content

UsagePageFileGenerator

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

Properties​

USAGE_PAGE_DIRECTORY_TEMPLATE​

private static $USAGE_PAGE_DIRECTORY_TEMPLATE
  • This property is static.

USAGE_DIR_PATH​

private static $USAGE_DIR_PATH
  • This property is static.

pagePathInfo​

private \Documentation\Generator\UsagePage\PagePathInfo $pagePathInfo

configuration​

private \Documentation\Generator\Configuration $configuration

documentationTestConfig​

private \Documentation\Test\Config $documentationTestConfig

Methods​

__construct​

public __construct(\Documentation\Generator\Configuration $configuration, \Documentation\Test\Config $documentationTestConfig): mixed

Parameters:

ParameterTypeDescription
$configuration\Documentation\Generator\Configuration
$documentationTestConfig\Documentation\Test\Config

generate​

public generate(string $content): mixed

Parameters:

ParameterTypeDescription
$contentstring

getPagePathInfo​

public getPagePathInfo(): \Documentation\Generator\UsagePage\PagePathInfo

generatePagePathInfo​

private generatePagePathInfo(): mixed

getUsageDirPath​

private getUsageDirPath(): mixed

sanitizePath​

private sanitizePath(mixed $path): mixed

Parameters:

ParameterTypeDescription
$pathmixed

generateCategoryFile​

private generateCategoryFile(): mixed