Properties

$configFactory

$configFactory : \phpDocumentor\Configuration\ConfigurationFactory

Type

ConfigurationFactory

$currentWorkingDir

$currentWorkingDir : \phpDocumentor\Dsn

Type

Dsn

Methods

__construct()

__construct((string|string[])[]  $options, \phpDocumentor\Configuration\ConfigurationFactory  $configFactory, string  $currentWorkingDir) : mixed

Parameters

(string|string[])[] $options
\phpDocumentor\Configuration\ConfigurationFactory $configFactory
string $currentWorkingDir

Returns

mixed —

__invoke()

__invoke(\phpDocumentor\Configuration\Configuration  $configuration, ?\League\Uri\Contracts\UriInterface  $uri = null) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration
?\League\Uri\Contracts\UriInterface $uri

Returns

\phpDocumentor\Configuration\Configuration —

overwriteDestinationFolder()

overwriteDestinationFolder(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

disableCache()

disableCache(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

overwriteCacheFolder()

overwriteCacheFolder(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

overwriteTitle()

overwriteTitle(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

overwriteTemplates()

overwriteTemplates(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

setFilesInPath()

setFilesInPath(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

setDirectoriesInPath()

setDirectoriesInPath(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

registerExtensions()

registerExtensions(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteIgnoredPaths()

overwriteIgnoredPaths(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteIgnoredTags()

overwriteIgnoredTags(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteMarkers()

overwriteMarkers(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteIncludeSource()

overwriteIncludeSource(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteVisibility()

overwriteVisibility(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteDefaultPackageName()

overwriteDefaultPackageName(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

overwriteExamples()

overwriteExamples(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —

createDefaultVersionSettings()

createDefaultVersionSettings() : \phpDocumentor\Configuration\VersionSpecification

Returns

\phpDocumentor\Configuration\VersionSpecification —

createDefaultApiSettings()

createDefaultApiSettings() : \phpDocumentor\Configuration\ApiSpecification

Returns

\phpDocumentor\Configuration\ApiSpecification —

shouldReduceNumberOfVersionsToOne()

shouldReduceNumberOfVersionsToOne(\phpDocumentor\Configuration\Configuration  $configuration) : 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.

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

bool —

overwriteSettings()

overwriteSettings(\phpDocumentor\Configuration\Configuration  $configuration) : \phpDocumentor\Configuration\Configuration

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

overwriteEncoding()

overwriteEncoding(\phpDocumentor\Configuration\VersionSpecification  $version) : \phpDocumentor\Configuration\VersionSpecification

Parameters

\phpDocumentor\Configuration\VersionSpecification $version

Returns

\phpDocumentor\Configuration\VersionSpecification —