phpDocumentor

Configuration
in package

Table of Contents

$baseUrl  : string
$baseUrlEnabledCallable  : callable|null
$fileExtension  : string
$formats  : array<string|int, Format>
$ignoreInvalidReferences  : bool
$indexName  : string
$initialHeaderLevel  : int
$outputFolder  : string
$sourceFileExtension  : string
__construct()  : mixed
addFormat()  : void
getBaseUrl()  : string
getBaseUrlEnabledCallable()  : callable|null
getFileExtension()  : string
getFormat()  : Format
getIgnoreInvalidReferences()  : bool
getInitialHeaderLevel()  : int
getNameOfIndexFile()  : string
getOutputFolder()  : string
getSourceFileExtension()  : string
isBaseUrlEnabled()  : bool
setBaseUrl()  : self
setBaseUrlEnabledCallable()  : void
setFileExtension()  : void
setIgnoreInvalidReferences()  : void
setInitialHeaderLevel()  : void
setOutputFolder()  : void

Properties

$baseUrlEnabledCallable

private callable|null $baseUrlEnabledCallable

$fileExtension

private string $fileExtension = phpDocumentorGuidesFormatsFormat::HTML

$ignoreInvalidReferences

private bool $ignoreInvalidReferences = false

$sourceFileExtension

private string $sourceFileExtension = 'rst'

Methods

__construct()

public __construct(string $sourceFileExtension, iteratable<string|int, Format$outputFormats) : mixed
Parameters
$sourceFileExtension : string
$outputFormats : iteratable<string|int, Format>
Return values
mixed

getBaseUrl()

public getBaseUrl() : string
Return values
string

getBaseUrlEnabledCallable()

public getBaseUrlEnabledCallable() : callable|null
Return values
callable|null

getFileExtension()

public getFileExtension() : string
Return values
string

getIgnoreInvalidReferences()

public getIgnoreInvalidReferences() : bool
Return values
bool

getInitialHeaderLevel()

public getInitialHeaderLevel() : int
Return values
int

getNameOfIndexFile()

public getNameOfIndexFile() : string
Return values
string

getOutputFolder()

public getOutputFolder() : string
Return values
string

getSourceFileExtension()

public getSourceFileExtension() : string
Return values
string

isBaseUrlEnabled()

public isBaseUrlEnabled(string $path) : bool
Parameters
$path : string
Return values
bool

setBaseUrl()

public setBaseUrl(string $baseUrl) : self
Parameters
$baseUrl : string
Return values
self

setBaseUrlEnabledCallable()

public setBaseUrlEnabledCallable(callable|null $baseUrlEnabledCallable) : void
Parameters
$baseUrlEnabledCallable : callable|null
Return values
void

setFileExtension()

public setFileExtension(string $fileExtension) : void
Parameters
$fileExtension : string
Return values
void

setIgnoreInvalidReferences()

public setIgnoreInvalidReferences(bool $ignoreInvalidReferences) : void
Parameters
$ignoreInvalidReferences : bool
Return values
void

setInitialHeaderLevel()

public setInitialHeaderLevel(int $initialHeaderLevel) : void
Parameters
$initialHeaderLevel : int
Return values
void

setOutputFolder()

public setOutputFolder(string $outputFolder) : void
Parameters
$outputFolder : string
Return values
void

Search results