SiteDoctor
Site diagnosis domain service.
Table of Contents
Methods
- diagnose() : array{environment: array
, paths: array , checks: array , warnings: int, errors: int} - addCheck() : void
- checkDirectoryWritable() : array{0: bool, 1: string}
- Checks if a directory exists or can be created and is writable.
- checkLanguagesConfiguration() : array{0: bool, 1: string}
- Checks language configuration consistency.
- checkOutputFormatsMapping() : array{0: bool, 1: string}
- Checks that page type formats reference existing output formats.
- formatConfigFiles() : string
- getCachePathDisplay() : string
- Returns the configured cache path without creating directories.
- validateUrl() : string
- Validate URL.
Methods
diagnose()
public
diagnose(Builder $builder, string $workingDirectory, array<int, string> $configFiles) : array{environment: array, paths: array, checks: array, warnings: int, errors: int}
Parameters
- $builder : Builder
- $workingDirectory : string
- $configFiles : array<int, string>
Return values
array{environment: arrayaddCheck()
private
addCheck(array<int, array{item: string, status: string, details: string}> &$checks, string $label, bool $success, string $successDetails, string $failureDetails, string $failureSeverity, int &$warnings, int &$errors) : void
Parameters
- $checks : array<int, array{item: string, status: string, details: string}>
- $label : string
- $success : bool
- $successDetails : string
- $failureDetails : string
- $failureSeverity : string
- $warnings : int
- $errors : int
checkDirectoryWritable()
Checks if a directory exists or can be created and is writable.
private
checkDirectoryWritable(string $directory) : array{0: bool, 1: string}
Parameters
- $directory : string
Return values
array{0: bool, 1: string}checkLanguagesConfiguration()
Checks language configuration consistency.
private
checkLanguagesConfiguration(Config $config) : array{0: bool, 1: string}
Parameters
- $config : Config
Return values
array{0: bool, 1: string}checkOutputFormatsMapping()
Checks that page type formats reference existing output formats.
private
checkOutputFormatsMapping(Config $config) : array{0: bool, 1: string}
Parameters
- $config : Config
Return values
array{0: bool, 1: string}formatConfigFiles()
private
formatConfigFiles(array<int, string> $configFiles) : string
Parameters
- $configFiles : array<int, string>
Return values
stringgetCachePathDisplay()
Returns the configured cache path without creating directories.
private
getCachePathDisplay(Config $config) : string
Parameters
- $config : Config
Return values
stringvalidateUrl()
Validate URL.
private
validateUrl(string $url) : string
Parameters
- $url : string