phpDocumentor

CommandlineOptionsMiddleware
in package
implements MiddlewareInterface

Interfaces, Classes and Traits

MiddlewareInterface

Table of Contents

$configFactory  : ConfigurationFactory
$currentWorkingDir  : Dsn
$options  : array<string|int, string|string[]>
__construct()  : mixed
__invoke()  : array<string|int, mixed>
createDefaultApiSettings()  : array<string|int, mixed>
createDefaultVersionSettings()  : VersionSpecification
disableCache()  : array<string|int, mixed>
Changes the given configuration array so that the cache handling is disabled.
overwriteCacheFolder()  : array<string|int, mixed>
overwriteDefaultPackageName()  : VersionSpecification
overwriteDestinationFolder()  : array<string|int, mixed>
overwriteEncoding()  : VersionSpecification
overwriteExamples()  : VersionSpecification
overwriteIgnoredPaths()  : VersionSpecification
overwriteIgnoredTags()  : VersionSpecification
overwriteIncludeSource()  : VersionSpecification
overwriteMarkers()  : VersionSpecification
overwriteSettings()  : array<string|int, mixed>
overwriteTemplates()  : array<string|int, mixed>
Changes the given configuration array to feature the templates from the options.
overwriteTitle()  : array<string|int, mixed>
overwriteVisibility()  : VersionSpecification
registerExtensions()  : VersionSpecification
setDirectoriesInPath()  : VersionSpecification
setFilesInPath()  : VersionSpecification
shouldReduceNumberOfVersionsToOne()  : bool
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.

Properties

Methods

__invoke()

public __invoke(array<string|int, mixed> $configuration[, UriInterface|null $uri = null ]) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
$uri : UriInterface|null = null
Return values
array<string|int, mixed>

createDefaultApiSettings()

private createDefaultApiSettings() : array<string|int, mixed>
Return values
array<string|int, mixed>

disableCache()

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

private disableCache(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

overwriteCacheFolder()

private overwriteCacheFolder(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

overwriteDestinationFolder()

private overwriteDestinationFolder(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

overwriteSettings()

private overwriteSettings(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

overwriteTemplates()

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

private overwriteTemplates(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

overwriteTitle()

private overwriteTitle(array<string|int, mixed> $configuration) : array<string|int, mixed>
Parameters
$configuration : array<string|int, mixed>
Return values
array<string|int, mixed>

shouldReduceNumberOfVersionsToOne()

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.

private shouldReduceNumberOfVersionsToOne(array<string|int, mixed> $configuration) : bool
Parameters
$configuration : array<string|int, mixed>
Return values
bool

Search results