ProjectSettings
in package
FinalYes
Table of Contents
Properties
- $copyright : string
- $defaultCodeLanguage : string
- $failOnError : string|null
- $ignoredDomains : array<string|int, string>
- $input : string
- $inputFile : string
- $inputFormat : string
- $inventories : array<string, string>
- $linksRelative : bool
- $logPath : string
- $maxMenuDepth : int
- $output : string
- $outputFormats : array<string|int, string>
- $release : string
- $showProgressBar : bool
- $theme : string
- $title : string
- $version : string
Methods
- getCopyright() : string
- getDefaultCodeLanguage() : string
- getFailOnError() : string|null
- getIgnoredDomains() : array<string|int, string>
- getInput() : string
- getInputFile() : string
- getInputFormat() : string
- getInventories() : array<string, string>
- getLogPath() : string
- getMaxMenuDepth() : int
- getOutput() : string
- getOutputFormats() : array<string|int, string>
- getRelease() : string
- getTheme() : string
- getTitle() : string
- getVersion() : string
- isFailOnError() : bool
- isLinksRelative() : bool
- isShowProgressBar() : bool
- setCopyright() : void
- setDefaultCodeLanguage() : void
- setFailOnError() : void
- setIgnoredDomains() : void
- setInput() : void
- setInputFile() : void
- setInputFormat() : void
- setInventories() : void
- setLinksRelative() : void
- setLogPath() : void
- setMaxMenuDepth() : ProjectSettings
- setOutput() : void
- setOutputFormats() : void
- setRelease() : void
- setShowProgressBar() : void
- setTheme() : void
- setTitle() : void
- setVersion() : void
Properties
$copyright
private
string
$copyright
= ''
$defaultCodeLanguage
private
string
$defaultCodeLanguage
= ''
$failOnError
private
string|null
$failOnError
= null
$ignoredDomains
private
array<string|int, string>
$ignoredDomains
= []
$input
private
string
$input
= 'docs'
$inputFile
private
string
$inputFile
= ''
$inputFormat
private
string
$inputFormat
= 'rst'
$inventories
private
array<string, string>
$inventories
= []
$linksRelative
private
bool
$linksRelative
= false
$logPath
private
string
$logPath
= 'php://stder'
$maxMenuDepth
private
int
$maxMenuDepth
= 0
$output
private
string
$output
= 'output'
$outputFormats
private
array<string|int, string>
$outputFormats
= ['html']
$release
private
string
$release
= ''
$showProgressBar
private
bool
$showProgressBar
= true
$theme
private
string
$theme
= 'default'
$title
private
string
$title
= ''
$version
private
string
$version
= ''
Methods
getCopyright()
public
getCopyright() : string
Return values
stringgetDefaultCodeLanguage()
public
getDefaultCodeLanguage() : string
Return values
stringgetFailOnError()
public
getFailOnError() : string|null
Return values
string|nullgetIgnoredDomains()
public
getIgnoredDomains() : array<string|int, string>
Return values
array<string|int, string>getInput()
public
getInput() : string
Return values
stringgetInputFile()
public
getInputFile() : string
Return values
stringgetInputFormat()
public
getInputFormat() : string
Return values
stringgetInventories()
public
getInventories() : array<string, string>
Return values
array<string, string>getLogPath()
public
getLogPath() : string
Return values
stringgetMaxMenuDepth()
public
getMaxMenuDepth() : int
Return values
intgetOutput()
public
getOutput() : string
Return values
stringgetOutputFormats()
public
getOutputFormats() : array<string|int, string>
Return values
array<string|int, string>getRelease()
public
getRelease() : string
Return values
stringgetTheme()
public
getTheme() : string
Return values
stringgetTitle()
public
getTitle() : string
Return values
stringgetVersion()
public
getVersion() : string
Return values
stringisFailOnError()
public
isFailOnError() : bool
Return values
boolisLinksRelative()
public
isLinksRelative() : bool
Return values
boolisShowProgressBar()
public
isShowProgressBar() : bool
Return values
boolsetCopyright()
public
setCopyright(string $copyright) : void
Parameters
- $copyright : string
setDefaultCodeLanguage()
public
setDefaultCodeLanguage(string $defaultCodeLanguage) : void
Parameters
- $defaultCodeLanguage : string
setFailOnError()
public
setFailOnError(string $logLevel) : void
Parameters
- $logLevel : string
setIgnoredDomains()
public
setIgnoredDomains(array<string|int, string> $ignoredDomains) : void
Parameters
- $ignoredDomains : array<string|int, string>
setInput()
public
setInput(string $input) : void
Parameters
- $input : string
setInputFile()
public
setInputFile(string $inputFile) : void
Parameters
- $inputFile : string
setInputFormat()
public
setInputFormat(string $inputFormat) : void
Parameters
- $inputFormat : string
setInventories()
public
setInventories(array<string, string> $inventories) : void
Parameters
- $inventories : array<string, string>
setLinksRelative()
public
setLinksRelative(bool $linksRelative) : void
Parameters
- $linksRelative : bool
setLogPath()
public
setLogPath(string $logPath) : void
Parameters
- $logPath : string
setMaxMenuDepth()
public
setMaxMenuDepth(int $maxMenuDepth) : ProjectSettings
Parameters
- $maxMenuDepth : int
Return values
ProjectSettingssetOutput()
public
setOutput(string $output) : void
Parameters
- $output : string
setOutputFormats()
public
setOutputFormats(array<string|int, string> $outputFormats) : void
Parameters
- $outputFormats : array<string|int, string>
setRelease()
public
setRelease(string $release) : void
Parameters
- $release : string
setShowProgressBar()
public
setShowProgressBar(bool $showProgressBar) : void
Parameters
- $showProgressBar : bool
setTheme()
public
setTheme(string $theme) : void
Parameters
- $theme : string
setTitle()
public
setTitle(string $title) : void
Parameters
- $title : string
setVersion()
public
setVersion(string $version) : void
Parameters
- $version : string