CommandlineOptionsMiddleware
in package
implements
MiddlewareInterface
Interfaces, Classes and Traits
Table of Contents
- $configFactory : ConfigurationFactory
- $currentWorkingDir : Dsn
- $options : array<string|int, string|string[]>
- __construct() : mixed
- __invoke() : Configuration
- createDefaultApiSettings() : ApiSpecification
- createDefaultVersionSettings() : VersionSpecification
- disableCache() : Configuration
- overwriteCacheFolder() : Configuration
- overwriteDefaultPackageName() : VersionSpecification
- overwriteDestinationFolder() : Configuration
- overwriteEncoding() : VersionSpecification
- overwriteExamples() : VersionSpecification
- overwriteIgnoredPaths() : VersionSpecification
- overwriteIgnoredTags() : VersionSpecification
- overwriteIncludeSource() : VersionSpecification
- overwriteMarkers() : VersionSpecification
- overwriteSettings() : Configuration
- overwriteTemplates() : Configuration
- overwriteTitle() : Configuration
- 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
$configFactory
private
ConfigurationFactory
$configFactory
$currentWorkingDir
private
Dsn
$currentWorkingDir
$options
private
array<string|int, string|string[]>
$options
Methods
__construct()
public
__construct(array<string|int, string|string[]> $options, ConfigurationFactory $configFactory, string $currentWorkingDir) : mixed
Parameters
- $options : array<string|int, string|string[]>
- $configFactory : ConfigurationFactory
- $currentWorkingDir : string
Return values
mixed —__invoke()
public
__invoke(Configuration $configuration[, UriInterface|null $uri = null ]) : Configuration
Parameters
- $configuration : Configuration
- $uri : UriInterface|null = null
Return values
Configuration —createDefaultApiSettings()
private
createDefaultApiSettings() : ApiSpecification
Return values
ApiSpecification —createDefaultVersionSettings()
private
createDefaultVersionSettings() : VersionSpecification
Return values
VersionSpecification —disableCache()
private
disableCache(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteCacheFolder()
private
overwriteCacheFolder(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteDefaultPackageName()
private
overwriteDefaultPackageName(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteDestinationFolder()
private
overwriteDestinationFolder(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteEncoding()
private
overwriteEncoding(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteExamples()
private
overwriteExamples(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteIgnoredPaths()
private
overwriteIgnoredPaths(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteIgnoredTags()
private
overwriteIgnoredTags(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteIncludeSource()
private
overwriteIncludeSource(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteMarkers()
private
overwriteMarkers(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —overwriteSettings()
private
overwriteSettings(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteTemplates()
private
overwriteTemplates(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteTitle()
private
overwriteTitle(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
Configuration —overwriteVisibility()
private
overwriteVisibility(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —registerExtensions()
private
registerExtensions(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —setDirectoriesInPath()
private
setDirectoriesInPath(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —setFilesInPath()
private
setFilesInPath(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecification —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(Configuration $configuration) : bool
Parameters
- $configuration : Configuration