\phpDocumentor\Transformer\ConfigurationExternalClassDocumentation

Reference that relates classes with a specific prefix to a URL template.

Summary

Methods
Properties
Constants
__construct()
getPrefix()
getUri()
No public properties found
No constants found
No protected methods found
$prefix
$uri
N/A
No private methods found
No private properties found
N/A

Properties

$prefix

$prefix : string

Type

string — the prefix that a class should have to contain in order for this reference to apply.

$uri

$uri : string

Type

string — The URI template that is used to construct a link to the documentation.

Methods

__construct()

__construct(string  $prefix, string  $uri) 

Registers the prefix and uri on this configuration item.

Parameters

string $prefix
string $uri

getPrefix()

getPrefix() : string

Returns the prefix that a class should have to contain in order for this reference to apply.

Returns

string

getUri()

getUri() : string

The URI template that is used to construct a link to the documentation for classes with the prefix in this reference.

The URI templates may contain the following variables:

  • {CLASS}, the Qualified Class Name for the discovered class will be inserted here.

Returns

string