\phpDocumentor\Plugin\Core\XsltExtension

XSLT filters that can be used inside a template.

Summary

Methods
Properties
Constants
markdown()
path()
typeOfElement()
$descriptorBuilder
$routers
No constants found
No protected methods found
No protected properties found
N/A
getDocumentedElement()
No private properties found
N/A

Properties

Methods

markdown()

markdown(string  $text) : string

Markdown filter.

Example usage inside template would be:

<div class="long_description">
    <xsl:value-of
        select="php:function('phpDocumentor\Plugin\Core\Xslt\Extension::markdown',
            string(docblock/long-description))"
        disable-output-escaping="yes" />
</div>

Parameters

string $text

Returns

string

path()

path(string  $fqsen) : boolean|string

Returns a relative URL from the webroot if the given FQSEN exists in the project.

Example usage inside template would be (where @link is an attribute called link):

<xsl:value-of select="php:function('phpDocumentor\Plugin\Core\Xslt\Extension::path', string(@link))" />

Parameters

string $fqsen

Returns

boolean|string

typeOfElement()

typeOfElement(string  $link) : string

Example usage inside template would be (where @link is an attribute called link):

<xsl:value-of select="php:function('phpDocumentor\Plugin\Core\Xslt\Extension::typeOfElement', string(@link))" />

Parameters

string $link

Returns

string

getDocumentedElement()

getDocumentedElement(string  $fqsen) : boolean|\phpDocumentor\Descriptor\DescriptorAbstract

Returns a Descriptor Object if the given FQSEN exists in the project.

Parameters

string $fqsen

Returns

boolean|\phpDocumentor\Descriptor\DescriptorAbstract