Xsl

Extends \phpDocumentor\Transformer\Writer\WriterAbstract Implements \phpDocumentor\Transformer\Writer\Routable

XSL transformation writer; generates static HTML out of the structure and XSL templates.

package

Default

Methods

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

__construct(\Monolog\Logger $logger) 

Arguments

$logger

\Monolog\Logger

Checks if there is a space in the path.

checkForSpacesInPath(string $path) : void
inherited
Throws
\InvalidArgumentException

if path contains a space.

Arguments

$path

string

This method verifies whether PHP has all requirements needed to run this writer.

checkRequirements() : void
inherited

If one of the requirements is missing for this Writer then an exception of type RequirementMissing should be thrown; this indicates to the calling process that this writer will not function.

Throws
\phpDocumentor\Transformer\Writer\Exception\RequirementMissing

when a requirements is missing stating which one.

generateUrlForXmlElement

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

Arguments

$element

Response

false|string

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

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

Arguments

Response

string|null

getAstPath

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

Arguments

Response

string

getXslProcessor

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

Arguments

Response

\XSLTCache|\XSLTProcessor

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

getXsltUriFromFilename(string $filename) : string

Arguments

$filename

string

Response

string

loadAst

loadAst( $structureFilename) : \DOMDocument

Arguments

$structureFilename

Response

\DOMDocument

registerDefaultVariables

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

Arguments

$proc

$structure

Sets the parameters of the XSLT processor.

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

Arguments

$transformation

\phpDocumentor\Transformer\Transformation

Transformation.

$proc

\XSLTProcessor

XSLTProcessor.

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

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

Abstract definition of the transformation method.

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

Arguments

$project

\phpDocumentor\Descriptor\ProjectDescriptor

Document containing the structure.

$transformation

\phpDocumentor\Transformer\Transformation

Transformation to execute.

writeToFile

writeToFile( $filename,  $proc,  $structure) 

Arguments

$filename

$proc

$structure

Properties

logger

logger : \Monolog\Logger
var

Type(s)

\Monolog\Logger

xsl_variables

xsl_variables : array<mixed,string>
var

Type(s)

array<mixed,string>

routers

routers : \phpDocumentor\Transformer\Router\Queue