$router
$router : \phpDocumentor\Transformer\Router\Router
generate(\phpDocumentor\Descriptor\Descriptor $descriptor, \phpDocumentor\Transformer\Transformation $transformation) : string
Uses the currently selected node and transformation to assemble the destination path for the file.
Writers accept the use of a Query to be able to generate output for multiple objects using the same template.
The given node is the result of such a query, or if no query given the selected element, and the transformation contains the destination file.
Since it is important to be able to generate a unique name per element can the user provide a template variable in the name of the file. Such a template variable always resides between double braces and tries to take the node value of a given query string.
Example:
An artifact stating classes/{{name}}.html
will try to find the
node 'name' as a child of the given $node and use that value instead.
\phpDocumentor\Descriptor\Descriptor | $descriptor | |
\phpDocumentor\Transformer\Transformation | $transformation |
If no artifact is provided and no routing rule matches.
If the provided node does not contain anything.
returns the destination location or false if generation should be aborted.