tasks/ext/phpmd/PHPMDTask.php
\PHPMDTask
Runs PHP Mess Detector. Checking PHP files for several potential problems based on rulesets.
Use {@link Project#createTask} to register a new Task.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Benjamin Schultz
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.1
- Version
- $Id: 35668c2c6fbf1ca87fab21c26fd55ef630458fc7 $
Properties


array
$allowedFileExtensions= 'array('php')'
List of valid file extensions for analyzed files.
array('php')
Details- Type
- array


\PhingFile
$file= 'null'
A php source code filename or directory
null
Details- Type
- \PhingFile


\array<FileSet>
$filesets= 'array()'
All fileset objects assigned to this task
array()
Details- Type
- \array<FileSet>


\array<PHPMDFormatterElement>
$formatters= 'array()'
Formatter elements.
array()
Details- Type
- \array<PHPMDFormatterElement>


array
$ignorePatterns= 'array('.git', '.svn', 'CVS', '.bzr', '.hg')'
List of exclude directory patterns.
array('.git', '.svn', 'CVS', '.bzr', '.hg')
Details- Type
- array


integer
$minimumPriority= '0'
The minimum priority for rules to load.
0
Details- Type
- integer


\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


string
$rulesets= ''codesize,unusedcode''
The rule-set filenames or identifier.
'codesize,unusedcode'
Details- Type
- string
Methods


createFileSet(
)
:
\FileSet
Nested creator, adds a set of files (nested fileset attribute).
Type | Description |
---|---|
\FileSet | The created fileset object |


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


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
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 PHPMD 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.
Exception | Description |
---|---|
\BuildException | - if the phpmd classes can't be loaded. |


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

setAllowedFileExtensions(
string $fileExtensions
)
:
void
Sets a list of filename extensions for valid php source code files.
Name | Type | Description |
---|---|---|
$fileExtensions | string | List of valid file extensions without leading dot. |


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


setFile(
\PhingFile $file
)
:
void
Set the input source file or directory.
Name | Type | Description |
---|---|---|
$file | \PhingFile | The input source file or directory. |


setIgnorePatterns(
string $ignorePatterns
)
:
void
Sets a list of ignore patterns that is used to exclude directories from the source analysis.
Name | Type | Description |
---|---|---|
$ignorePatterns | string | List of ignore 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. |


setMinimumPriority(
integer $minimumPriority
)
:
void
Sets the minimum rule priority.
Name | Type | Description |
---|---|---|
$minimumPriority | integer | Minimum rule priority. |


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 |


setRulesets(
string $ruleSetFileNames
)
:
void
Sets the rule-sets.
Name | Type | Description |
---|---|---|
$ruleSetFileNames | string | Comma-separated string of rule-set filenames or identifier. |


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 |


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) |