CommandlineOptionsMiddleware

in package

Properties

private$options  : (string|string[])[]                

private$configFactory  : \phpDocumentor\Configuration\ConfigurationFactory                

private$currentWorkingDir  : \phpDocumentor\Dsn                

Methods

public__construct((string|string[])[] $options, ConfigurationFactory $configFactory, string $currentWorkingDir) : mixed

Parameters

$options : (string|string[])[]
$configFactory : ConfigurationFactory
$currentWorkingDir : string

Returns

mixed

public__invoke(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

privateoverwriteDestinationFolder(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

Changes the given configuration array so that the cache handling is disabled.

privatedisableCache(array>> $configuration) : array|bool>>

Parameters

$configuration : array>>

Returns

array|bool>>

privateoverwriteCacheFolder(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

privateoverwriteTitle(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

Changes the given configuration array to feature the templates from the options.

privateoverwriteTemplates(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

privatesetFilesInPath(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privatesetDirectoriesInPath(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateregisterExtensions(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateoverwriteIgnoredPaths(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateoverwriteMarkers(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateoverwriteIncludeSource(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateoverwriteVisibility(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privateoverwriteDefaultPackageName(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>

privatecreateDefaultVersionSettings() : array

Returns

array

privatecreateDefaultApiSettings() : array

Returns

array

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

Parameters

$configuration : array>>

Returns

bool

privateoverwriteSettings(array>> $configuration) : array>>

Parameters

$configuration : array>>

Returns

array>>

privateoverwriteEncoding(array>> $version) : array>>

Parameters

$version : array>>

Returns

array>>