tasks/ext/PhpCodeSnifferTask.php
A PHP code sniffer task. Checking the style of one or more PHP source files.
- Author
- Dirk Thomas
- Package
- phing.tasks.ext
- Version
- $Id: 8c8f9369e06a3467e34fc8d89f6355df048ece90 $
\PhpCodeSnifferTask
A PHP code sniffer task. Checking the style of one or more PHP source files.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Dirk Thomas
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Version
- $Id: 8c8f9369e06a3467e34fc8d89f6355df048ece90 $
Properties


\PhingFile
$docFile= 'null'
Holds the outfile for the documentation
null
Details- Type
- \PhingFile


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\Task::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \Task::$$project
Methods


createConfig(
)
:
\Parameter
Creates a config parameter for this task
Type | Description |
---|---|
\Parameter | The created parameter |


createFileSet(
)
:
\FileSet
Nested creator, creates a FileSet for this task
Type | Description |
---|---|
\FileSet | The created fileset object |


createFormatter(
)
:
\CodeSniffer_FormatterElement
Create object for nested formatter element.
Type | Description |
---|---|
\CodeSniffer_FormatterElement |


getLocation(
)
:
\Location
Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.
Inherited from: \Task::getLocation()Type | Description |
---|---|
\Location | The location object describing the position of this task within the buildfile. |


getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\Task::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


getRuntimeConfigurableWrapper(
)
:
\RuntimeConfigurable
Returns the wrapper object for runtime configuration
Inherited from: \Task::getRuntimeConfigurableWrapper()Type | Description |
---|---|
\RuntimeConfigurable | The wrapper object used by this task |


getTaskType(
)
:
string
Returns the name of the task under which it was invoked, usually the XML tagname
Inherited from: \Task::getTaskType()Type | Description |
---|---|
string | The type of this task (XML Tag) |


init(
)
:
void
Load the necessary environment for running PHP_CodeSniffer.
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exception | Description |
---|---|
\BuildException |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Name | Type | Description |
---|---|---|
$msg | string | The message to log |
$level | integer | The priority of the message |
- See
- \BuildEvent
- See
- \BuildListener


main(
)
:
void
Executes PHP code sniffer against PhingFile or a FileSet
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.


maybeConfigure(
)
:
void
Configure this task if it hasn't been done already.
Inherited from: \Task::maybeConfigure()

outputCustomFormat(
array $report
)
:
void
Outputs the results with a custom format
Name | Type | Description |
---|---|---|
$report | array | Packaged list of all errors in each file |


outputCustomFormatMessages(
array $messages, string $type
)
:
void
Outputs the messages of a specific type for one file
Name | Type | Description |
---|---|---|
$messages | array | |
$type | string |


printErrorReport(
\PHP_CodeSniffer $phpcs
)
:
int
Prints the error report.
Name | Type | Description |
---|---|---|
$phpcs | \PHP_CodeSniffer | The PHP_CodeSniffer object containing the errors. |
Type | Description |
---|---|
int | The number of error and warning messages shown. |


setAllowedFileExtensions(
array $extensions
)
:
void
Sets the allowed file extensions when using directories instead of specific files
Name | Type | Description |
---|---|---|
$extensions | array |


setDescription(
string $desc
)
:
void
Name | Type | Description |
---|---|---|
$desc | string | The text describing the task |


setDocFile(
\PhingFile $file
)
:
void
Sets the outfile for the documentation
Name | Type | Description |
---|---|---|
$file | \PhingFile | The outfile for the doc |


setDocGenerator(
string $generator
)
:
void
Sets the type of the doc generator
Name | Type | Description |
---|---|---|
$generator | string | HTML or Text |


setEncoding(
string $encoding
)
:
void
Sets file encoding
Name | Type | Description |
---|---|---|
$encoding | string |


setFile(
\PhingFile $file
)
:
void
File to be performed syntax check on
Name | Type | Description |
---|---|---|
$file | \PhingFile |


setFormat(
string $format
)
:
void
Sets the output format
Name | Type | Description |
---|---|---|
$format | string |


setHaltonerror(
boolean $value
)
:
void
Sets the haltonerror flag
Name | Type | Description |
---|---|---|
$value | boolean |


setHaltonwarning(
boolean $value
)
:
void
Sets the haltonwarning flag
Name | Type | Description |
---|---|---|
$value | boolean |


setIgnorePatterns(
$patterns
)
:
void
Sets the ignore patterns to skip files when using directories instead of specific files
Name | Type | Description |
---|---|---|
$patterns |


setLocation(
\Location $location
)
:
void
Sets the location within the buildfile this task occurs. Called by the parser to set location information.
Inherited from: \Task::setLocation()Name | Type | Description |
---|---|---|
$location | \Location | The location object describing the position of this task within the buildfile. |


setNoSubdirectories(
boolean $subdirectories
)
:
void
Sets the flag if subdirectories should be skipped
Name | Type | Description |
---|---|---|
$subdirectories | boolean |


setOwningTarget(
\Target $target
)
:
void
Name | Type | Description |
---|---|---|
$target | \Target | Reference to owning target |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\Task::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setReportWidth(
int $width
)
:
void
Sets the width of the report
Name | Type | Description |
---|---|---|
$width | int | How wide the screen reports should be. |


setRuntimeConfigurableWrapper(
\RuntimeConfigurable $wrapper
)
:
void
Sets the wrapper object this task should use for runtime configurable elements.
Inherited from: \Task::setRuntimeConfigurableWrapper()Name | Type | Description |
---|---|---|
$wrapper | \RuntimeConfigurable | The wrapper object this task should use |


setShowSniffs(
boolean $show
)
:
void
Sets the flag if the used sniffs should be listed
Name | Type | Description |
---|---|---|
$show | boolean |


setShowSources(
boolean $show
)
:
void
Sets the flag if sources should be shown
Name | Type | Description |
---|---|---|
$show | boolean | Whether to show sources or not |


setShowWarnings(
boolean $show
)
:
void
Sets the flag if warnings should be shown
Name | Type | Description |
---|---|---|
$show | boolean |


setSkipVersionCheck(
boolean $value
)
:
void
Sets the skipversioncheck flag
Name | Type | Description |
---|---|---|
$value | boolean |


setSniffs(
string $sniffs
)
:
void
Sets the sniffs which the standard should be restricted to
Name | Type | Description |
---|---|---|
$sniffs | string |


setStandard(
string $standard
)
:
void
Sets the coding standard to test for
Name | Type | Description |
---|---|---|
$standard | string | The coding standard |


setTabWidth(
int $width
)
:
void
Sets the tab width to replace tabs with spaces
Name | Type | Description |
---|---|---|
$width | int |


setTaskName(
string $name
)
:
string
Name | Type | Description |
---|---|---|
$name | string |
Type | Description |
---|---|
string | A string representing the name of this task for log |


setTaskType(
string $name
)
:
void
Sets the type of the task. Usually this is the name of the XML tag
Inherited from: \Task::setTaskType()Name | Type | Description |
---|---|---|
$name | string | The type of this task (XML Tag) |
\PhpCodeSnifferTask_FormatterElement
Base class for those classes that can appear inside the build file as stand alone data types.
This class handles the common description attribute and provides a default implementation for reference handling and checking for circular references that is appropriate for types that can not be nested inside elements of the same type (i.e. patternset but not path)
- Parent(s)
- \DataType < \ProjectComponent
- Author
- Andreas Aderhold
- Author
- Hans Lellelid
- Version
- $Id$
Properties


boolean
$checked= 'true'
Subclasses are responsible for setting this value to false if we'd need to investigate this condition (usually because a child element has been added that is a subclass of DataType).
true
Details- Type
- boolean
- Inherited_from
- \DataType::$$checked


\Project
$project= 'null'
Holds a reference to the project that a project component (a task, a target, etc.) belongs to
A reference to the current project instanceInherited from: \ProjectComponent::$$project\DataType::$$projectnull
Details- Type
- \Project
- Inherited_from
- \ProjectComponent::$$project
- Inherited_from
- \DataType::$$project
Methods


circularReference(
)
:
void
Creates an exception that indicates the user has generated a loop of data types referencing each other.
Inherited from: \DataType::circularReference()

dieOnCircularReference(
$stk, $p
)
:
void
Check to see whether any DataType we hold references to is included in the Stack (which holds all DataType instances that directly or indirectly reference this instance, including this instance itself).
Inherited from: \DataType::dieOnCircularReference()If one is included, throw a BuildException created by circularReference
This implementation is appropriate only for a DataType that cannot hold other DataTypes as children.
The general contract of this method is that it shouldn't do anything if checked is true and set it to true on exit.
Name | Type | Description |
---|---|---|
$stk | ||
$p |


getCheckedRef(
$requiredClass, $dataTypeName
)
:
void
Performs the check for circular references and returns the referenced object.
Inherited from: \DataType::getCheckedRef()Name | Type | Description |
---|---|---|
$requiredClass | ||
$dataTypeName |


getDescription(
)
:
void
Return the description for the current data type.
Inherited from: \DataType::getDescription()

getProject(
)
:
\Project
Returns a reference to current project
Inherited from: \ProjectComponent::getProject()\DataType::getProject()Type | Description |
---|---|
\Project | Reference to current porject object |


log(
string $msg, integer $level
=
Project::MSG_INFO
)
:
void
Logs a message with the given priority.
Inherited from: \ProjectComponent::log()\DataType::log()Name | Type | Description |
---|---|---|
$msg | string | The message to be logged. |
$level | integer | The message's priority at this message should have |


noChildrenAllowed(
)
:
void
Creates an exception that indicates that this XML element must not have child elements if the refid attribute is set.
Inherited from: \DataType::noChildrenAllowed()

setDescription(
$desc
)
:
void
Sets a description of the current data type. It will be useful in commenting what we are doing.
Inherited from: \DataType::setDescription()Name | Type | Description |
---|---|---|
$desc |


setProject(
\Project $project
)
:
void
References the project to the current component.
Inherited from: \ProjectComponent::setProject()\DataType::setProject()Name | Type | Description |
---|---|---|
$project | \Project | The reference to the current project |


setRefid(
\Reference $r
)
:
void
Subclasses may need to check whether any other attributes have been set as well or child elements have been created and thus override this method. if they do they must call parent::setRefid()
Name | Type | Description |
---|---|---|
$r | \Reference |


tooManyAttributes(
)
:
void
Creates an exception that indicates that refid has to be the only attribute if it is set.
Inherited from: \DataType::tooManyAttributes()