Checkstyle

Extends \phpDocumentor\Transformer\Writer\WriterAbstract Implements \phpDocumentor\Transformer\Writer\Translatable

Checkstyle transformation writer; generates checkstyle report

package	Default

Methods

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.

Retrieves the destination location for this artifact.

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

Arguments

$transformation

\phpDocumentor\Transformer\Transformation

Response

string

Returns an instance of the object responsible for translating content.

getTranslator() : \phpDocumentor\Translator\Translator

Response

\phpDocumentor\Translator\Translator

Save the checkstyle report to the artifact

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

Arguments

$artifact

string

Target name for the report

$document

\DOMDocument

The actual xml document being saved

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

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

Arguments

$translator

\phpDocumentor\Translator\Translator

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.

Properties

translator

translator : \phpDocumentor\Translator\Translator

var

Type(s)

\phpDocumentor\Translator\Translator