\phpDocumentor\Transformer\RouterRule

__construct()

__construct(callable  $matcher, callable  $generator) 

Initializes this rule.

Parameters

match()

match(string|\phpDocumentor\Descriptor\DescriptorAbstract  $node) : boolean

Returns true when this rule is applicable to the given node.

The contents of $node MAY be changed so that later rules in a router can try to match the changed value. An example of this is a string matcher that converts a provided FQSEN to a Descriptor so that Descriptor matchers in subsequent rules can generate a URL for it.

Parameters

Returns

generate()

generate(string|\phpDocumentor\Descriptor\DescriptorAbstract  $node) : string|false

Generates an URL for the given node.

Parameters

Returns

a well-formed relative or absolute URL, or false if no URL could be generated.

translateToUrlEncodedPath()

translateToUrlEncodedPath(string  $generatedPathAsUtf8) : string

Translates the provided path, with UTF-8 characters, into a web- and windows-safe variant.

Windows does not support the use of UTF-8 characters on their file-system. In order to be sure that both the web and windows can support the given filename we decode the UTF-8 characters and then url encode them so that they will be plain characters that are suitable for the web.

If an anchor is found in the path, then it is neither url_encoded not transliterated because it should not result in a filename (otherwise another part of the application has made an error) but may be used during rendering of templates.

Parameters

Returns