\phpDocumentor\ConfigurationPathNormalizingMiddleware

Summary

Methods
Properties
Constants
__invoke()
normalizeCachePath()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
makeDsnRelativeToConfig()
normalizePaths()
normalizePath()
pathToGlobPattern()
No private properties found
N/A

Methods

__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 —

normalizeCachePath()

normalizeCachePath(?\League\Uri\Contracts\UriInterface  $uri, \phpDocumentor\Path  $cachePath) : \phpDocumentor\Path

Parameters

?\League\Uri\Contracts\UriInterface $uri
\phpDocumentor\Path $cachePath

Returns

\phpDocumentor\Path —

makeDsnRelativeToConfig()

makeDsnRelativeToConfig(\phpDocumentor\Configuration\Configuration  $configuration, ?\League\Uri\Contracts\UriInterface  $uri) : \phpDocumentor\Configuration\Configuration

Transforms relative dsn to relative path of working dir.

The dsn defined in the config might be relative. If it is relative it is relative to the location of the config file. The config file could be outside the working directory. But we want to read from the current working dir.

Eg. the config is read from './config/phpdoc.xml' The defined source is '../src'

In this case the src dir on the same level as the config dir is read.

Absolute DSNs are untouched.

Parameters

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

Returns

\phpDocumentor\Configuration\Configuration —

normalizePaths()

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

Parameters

\phpDocumentor\Configuration\Configuration $configuration

Returns

\phpDocumentor\Configuration\Configuration —

normalizePath()

normalizePath(string  $path) : string

Parameters

string $path

Returns

string —

pathToGlobPattern()

pathToGlobPattern(string  $path) : string

Parameters

string $path

Returns

string —