\phpDocumentor\Plugin\Core\Transformer\WriterCheckstyle

checkRequirements()

checkRequirements() : void

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

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.

transform()

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

This method generates the checkstyle.xml report

Parameters

getTranslator()

getTranslator() : \phpDocumentor\Translator\Translator

Returns an instance of the object responsible for translating content.

Returns

setTranslator()

setTranslator(\phpDocumentor\Translator\Translator  $translator) : void

Sets a new object capable of translating strings on this writer.

Parameters

checkForSpacesInPath()

checkForSpacesInPath(string  $path) : void

Checks if there is a space in the path.

Parameters

Throws

\InvalidArgumentException

if path contains a space.

getDestinationPath()

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

Retrieves the destination location for this artifact.

Parameters

Returns

saveCheckstyleReport()

saveCheckstyleReport(string  $artifact, \DOMDocument  $document) : void

Save the checkstyle report to the artifact

Parameters