ExternalClassDocumentation

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

package

Default

Methods

Registers the prefix and uri on this configuration item.

__construct(string $prefix, string $uri) 

Arguments

$prefix

string

$uri

string

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

getPrefix() : string

Response

string

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

getUri() : string

The URI templates may contain the following variables:

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

Response

string

Properties

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

prefix : string
var

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

Serializer\Type

("string")

Type(s)

string

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

uri : string
var

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

Serializer\Type

("string")

Type(s)

string