A PHP code sniffer task. Checking the style of one or more PHP source files.
Use {@link Project#createTask} to register a new Task.
author |
Dirk Thomas dirk.thomas@4wdmedia.de |
---|---|
version |
$Id: 77c9b967ac25f02120abbec6ea85265a226b8918 $ |
package |
phing.tasks.ext |
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
throws |
---|
createFileSet() : \FileSet
setStandard(string $standard) : void
string
The coding standard
setSniffs(string $sniffs)
string
setDocGenerator(string $generator) : void
string
HTML or Text
setDocFile(\PhingFile $file) : void
setShowWarnings(boolean $show)
boolean
setShowSources(boolean $show) : void
boolean
Whether to show sources or not
setReportWidth(int $width) : void
int
How wide the screen reports should be.
setVerbosity(int $level)
int
setTabWidth(int $width)
int
setEncoding(string $encoding)
string
setAllowedFileExtensions(array $extensions)
array
setIgnorePatterns($patterns)
setNoSubdirectories(boolean $subdirectories)
boolean
createConfig() : \Parameter
setShowSniffs(boolean $show)
boolean
setFormat(string $format)
string
createFormatter() : \CodeSniffer_FormatterElement
\CodeSniffer_FormatterElement
setHaltonerror(boolean $value)
boolean
setHaltonwarning(boolean $value)
boolean
setSkipVersionCheck(boolean $value)
boolean
main()
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
printErrorReport(\PHP_CodeSniffer $phpcs) : int
\PHP_CodeSniffer
The PHP_CodeSniffer object containing the errors.
int
The number of error and warning messages shown.
outputCustomFormat(array $report)
array
Packaged list of all errors in each file
outputCustomFormatMessages(array $messages, string $type)
array
string
setOwningTarget(\Target $target)
getOwningTarget() : \Target
getTaskName() : string
string
Name of this task
setTaskName(string $name) : string
string
string
A string representing the name of this task for log
getTaskType() : string
string
The type of this task (XML Tag)
setTaskType($name)
getRegisterSlot(string $slotName)
string
log(string $msg, integer $level = \Project::MSG_INFO)
string
The message to be logged.
integer
The message's priority at this message should have
setDescription(string $desc)
string
The text describing the task
getDescription() : string
string
The text description of the task
getLocation() : \Location
setLocation(\Location $location)
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
maybeConfigure()
perform()
setProject(\Project $project)
getProject() : \Project
file :
filesets :
standard :
sniffs :
showWarnings :
showSources :
reportWidth :
verbosity :
tabWidth :
allowedFileExtensions :
ignorePatterns :
noSubdirectories :
configData :
encoding :
showSniffs :
format :
formatters :
docGenerator : string
var |
---|
string
haltonerror :
haltonwarning :
skipversioncheck :
description : string
var |
---|
string
taskType : string
var |
---|
string
taskName : string
var |
---|
string
project : \Project