Properties
$options Line 29
private$options : (string|string[])[]
$configFactory Line 32
private$configFactory : \phpDocumentor\Configuration\ConfigurationFactory
$currentWorkingDir Line 35
private$currentWorkingDir : \phpDocumentor\Dsn
Methods
__construct() Line 40
public__construct((string|string[])[] $options, ConfigurationFactory $configFactory, string $currentWorkingDir) : mixed
Parameters
Returns
mixed —
__invoke() Line 52
public__invoke(array>> $configuration) : array>>
Parameters
Returns
array
overwriteDestinationFolder() Line 91
privateoverwriteDestinationFolder(array>> $configuration) : array>>
Parameters
Returns
array
disableCache() Line 108
Changes the given configuration array so that the cache handling is disabled.
privatedisableCache(array>> $configuration) : array|bool>>
Parameters
Returns
array
overwriteCacheFolder() Line 122
privateoverwriteCacheFolder(array>> $configuration) : array>>
Parameters
Returns
array
overwriteTitle() Line 136
privateoverwriteTitle(array>> $configuration) : array>>
Parameters
Returns
array
overwriteTemplates() Line 152
Changes the given configuration array to feature the templates from the options.
privateoverwriteTemplates(array>> $configuration) : array>>
Parameters
Returns
array
setFilesInPath() Line 171
privatesetFilesInPath(array>> $version) : array>>
Parameters
Returns
array
setDirectoriesInPath() Line 199
privatesetDirectoriesInPath(array>> $version) : array>>
Parameters
Returns
array
registerExtensions() Line 245
privateregisterExtensions(array>> $version) : array>>
Parameters
Returns
array
overwriteIgnoredPaths() Line 265
privateoverwriteIgnoredPaths(array>> $version) : array>>
Parameters
Returns
array
overwriteMarkers() Line 290
privateoverwriteMarkers(array>> $version) : array>>
Parameters
Returns
array
overwriteIncludeSource() Line 310
privateoverwriteIncludeSource(array>> $version) : array>>
Parameters
Returns
array
overwriteVisibility() Line 330
privateoverwriteVisibility(array>> $version) : array>>
Parameters
Returns
array
overwriteDefaultPackageName() Line 353
privateoverwriteDefaultPackageName(array>> $version) : array>>
Parameters
Returns
array
createDefaultVersionSettings() Line 371
privatecreateDefaultVersionSettings() : array
Returns
array —
createDefaultApiSettings() Line 379
privatecreateDefaultApiSettings() : array
Returns
array —
shouldReduceNumberOfVersionsToOne() Line 390
If the source path was influenced; we can no longer reliable render multiple versions as such we reduce the list of versions to the last one; assuming that is the most recent / desirable one.
privateshouldReduceNumberOfVersionsToOne(array>> $configuration) : bool