\phpDocumentor\Plugin\Core\Transformer\WriterXsl

checkRequirements()

checkRequirements() : void

Checks whether XSL handling is enabled with PHP as that is not enabled by default.

To enable XSL handling you need either the xsl extension or the xslcache extension installed.

Throws

\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

if neither xsl extensions are installed.

transform()

transform(\phpDocumentor\Descriptor\ProjectDescriptor  $project, \phpDocumentor\Transformer\Transformation  $transformation) : void

This method combines the structure.xml and the given target template and creates a static html page at the artifact location.

Parameters

Throws

\RuntimeException

if the structure.xml file could not be found.

\phpDocumentor\Plugin\Core\Exception

if the structure.xml file's documentRoot could not be read because of encoding issues or because it was absent.

__construct()

__construct(\Monolog\Logger  $logger) 

Initialize this writer with the logger so that it can output logs.

Parameters

setRouters()

setRouters(\phpDocumentor\Transformer\Router\Queue  $routers) : void

Sets the routers that can be used to determine the path of links.

Parameters

setProcessorParameters()

setProcessorParameters(\phpDocumentor\Transformer\Transformation  $transformation, \XSLTProcessor  $proc) : void

Sets the parameters of the XSLT processor.

Parameters

checkForSpacesInPath()

checkForSpacesInPath(string  $path) : void

Checks if there is a space in the path.

Parameters

Throws

\InvalidArgumentException

if path contains a space.

getXsltUriFromFilename()

getXsltUriFromFilename(string  $filename) : string

Takes the filename and converts it into a correct URI for XSLTProcessor.

Parameters

Returns

getXslProcessor()

getXslProcessor(\phpDocumentor\Transformer\Transformation  $transformation) : \XSLTCache|\XSLTProcessor

Parameters

Returns

loadAst()

loadAst(  $structureFilename) : \DOMDocument

Parameters

Returns

registerDefaultVariables()

registerDefaultVariables(\phpDocumentor\Transformer\Transformation  $transformation,   $proc,   $structure) 

Parameters

writeToFile()

writeToFile(  $filename,   $proc,   $structure) 

Parameters

getAstPath()

getAstPath(\phpDocumentor\Transformer\Transformation  $transformation) : string

Parameters

Returns

getArtifactPath()

getArtifactPath(\phpDocumentor\Transformer\Transformation  $transformation) : string|null

Returns the path to the location where the artifact should be written, or null to automatically detect the location using the router.

Parameters

Returns

generateUrlForXmlElement()

generateUrlForXmlElement(\phpDocumentor\Descriptor\ProjectDescriptor  $project,   $element) : false|string

Parameters

Returns