CommandlineOptionsMiddleware implements MiddlewareInterface
FinalYes
Table of Contents
Interfaces
Properties
- $configFactory : ConfigurationFactory
- $currentWorkingDir : Dsn
- $options : array<string|int, mixed>
Methods
- __construct() : mixed
- __invoke() : Configuration
- createDefaultApiSettings() : ApiSpecification
- createDefaultVersionSettings() : VersionSpecification
- disableCache() : Configuration
- overwriteCacheFolder() : Configuration
- overwriteDefaultPackageName() : VersionSpecification
- overwriteDestinationFolder() : Configuration
- overwriteEncoding() : VersionSpecification
- overwriteExamples() : VersionSpecification
- overwriteIgnoredPaths() : VersionSpecification
- overwriteIgnoredSymlinks() : 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 read-only
private
ConfigurationFactory
$configFactory
$currentWorkingDir read-only
private
Dsn
$currentWorkingDir
$options read-only
private
array<string|int, mixed>
$options
Methods
__construct()
public
__construct(array<string|int, string|array<string|int, string>> $options, ConfigurationFactory $configFactory, string $currentWorkingDir) : mixed
Parameters
- $options : array<string|int, string|array<string|int, string>>
- $configFactory : ConfigurationFactory
- $currentWorkingDir : string
__invoke()
public
__invoke(Configuration $configuration[, UriInterface|null $uri = null ]) : Configuration
Parameters
- $configuration : Configuration
- $uri : UriInterface|null = null
Return values
ConfigurationcreateDefaultApiSettings()
private
createDefaultApiSettings() : ApiSpecification
Return values
ApiSpecificationcreateDefaultVersionSettings()
private
createDefaultVersionSettings() : VersionSpecification
Return values
VersionSpecificationdisableCache()
private
disableCache(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteCacheFolder()
private
overwriteCacheFolder(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteDefaultPackageName()
private
overwriteDefaultPackageName(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteDestinationFolder()
private
overwriteDestinationFolder(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteEncoding()
private
overwriteEncoding(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteExamples()
private
overwriteExamples(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteIgnoredPaths()
private
overwriteIgnoredPaths(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteIgnoredSymlinks()
private
overwriteIgnoredSymlinks(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteIgnoredTags()
private
overwriteIgnoredTags(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteIncludeSource()
private
overwriteIncludeSource(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteMarkers()
private
overwriteMarkers(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationoverwriteSettings()
private
overwriteSettings(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteTemplates()
private
overwriteTemplates(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteTitle()
private
overwriteTitle(Configuration $configuration) : Configuration
Parameters
- $configuration : Configuration
Return values
ConfigurationoverwriteVisibility()
private
overwriteVisibility(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationregisterExtensions()
private
registerExtensions(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationsetDirectoriesInPath()
private
setDirectoriesInPath(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationsetFilesInPath()
private
setFilesInPath(VersionSpecification $version) : VersionSpecification
Parameters
- $version : VersionSpecification
Return values
VersionSpecificationshouldReduceNumberOfVersionsToOne()
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