PHPMDTask

Extends \Task

Runs PHP Mess Detector. Checking PHP files for several potential problems based on rulesets.

Use {@link Project#createTask} to register a new Task.

package	phing.tasks.ext.phpmd
author	Benjamin Schultz bschultz@proqrent.de
version	$Id: 35668c2c6fbf1ca87fab21c26fd55ef630458fc7 $
since	2.4.1

Methods

Set the input source file or directory.

setFile(\PhingFile $file) : void

Arguments

$file

\PhingFile

The input source file or directory.

Nested creator, adds a set of files (nested fileset attribute).

createFileSet() : \FileSet

Response

\FileSet

The created fileset object

Sets the minimum rule priority.

setMinimumPriority(integer $minimumPriority) : void

Arguments

$minimumPriority

integer

Minimum rule priority.

Sets the rule-sets.

setRulesets(string $ruleSetFileNames) : void

Arguments

$ruleSetFileNames

string

Comma-separated string of rule-set filenames or identifier.

Sets a list of filename extensions for valid php source code files.

setAllowedFileExtensions(string $fileExtensions) : void

Arguments

$fileExtensions

string

List of valid file extensions without leading dot.

Sets a list of ignore patterns that is used to exclude directories from the source analysis.

setIgnorePatterns(string $ignorePatterns) : void

Arguments

$ignorePatterns

string

List of ignore patterns.

Create object for nested formatter element.

createFormatter() : \PHPMDFormatterElement

Response

\PHPMDFormatterElement

Called by the project to let the task do it's work. This method may be called more than once, if the task is invoked more than once. For example, if target1 and target2 both depend on target3, then running <em>phing target1 target2</em> will run all tasks in target3 twice.

main()

inherited abstract

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

Sets the owning target this task belongs to.

setOwningTarget(\Target $target)

inherited

Arguments

$target

\Target

Returns the owning target of this task.

getOwningTarget() : \Target

inherited

Response

\Target

The target object that owns this task

Returns the name of task, used only for log messages

getTaskName() : string

inherited

Response

string

Name of this task

Sets the name of this task for log messages

setTaskName(string $name) : string

inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

Returns the name of the task under which it was invoked, usually the XML tagname

getTaskType() : string

inherited

Response

string

The type of this task (XML Tag)

Sets the type of the task. Usually this is the name of the XML tag

setTaskType($name)

inherited

Arguments

$name

Returns a name

getRegisterSlot(string $slotName)

inherited

Arguments

$slotName

string

Logs a message with the given priority.

log(string $msg, integer $level = \Project::MSG_INFO)

inherited

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Sets a textual description of the task

setDescription(string $desc)

inherited

Arguments

$desc

string

The text describing the task

Returns the textual description of the task

getDescription() : string

inherited

Response

string

The text description of the task

Called by the parser to let the task initialize properly.

init()

inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location

inherited

Response

\Location

The location object describing the position of this task within the buildfile.

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

setLocation(\Location $location)

inherited

Arguments

$location

\Location

The location object describing the position of this task within the buildfile.

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable

inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Sets the wrapper object this task should use for runtime configurable elements.

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)

inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Configure this task if it hasn't been done already.

maybeConfigure()

inherited

Perfrom this task

perform()

inherited

References the project to the current component.

setProject(\Project $project)

inherited

Arguments

$project

\Project

The reference to the current project

Returns a reference to current project

getProject() : \Project

inherited

Response

\Project

Reference to current porject object

Properties

A php source code filename or directory

file : \PhingFile

var

Type(s)

\PhingFile

All fileset objects assigned to this task

filesets : \array<FileSet>

var

Type(s)

\array

The rule-set filenames or identifier.

rulesets : string

var

Type(s)

string

The minimum priority for rules to load.

minimumPriority : integer

var

Type(s)

integer

List of valid file extensions for analyzed files.

allowedFileExtensions : array

var

Type(s)

array

List of exclude directory patterns.

ignorePatterns : array

var

Type(s)

array

The format for the report

format : string

var

Type(s)

string

Formatter elements.

formatters : \array<PHPMDFormatterElement>

var

Type(s)

\array

Owning Target object

target : \Target

inherited

var

Type(s)

\Target

Description of the task

description : string

inherited

var

Type(s)

string

Internal taskname (req)

taskType : string

inherited

var

Type(s)

string

Taskname for logger

taskName : string

inherited

var

Type(s)

string

Stored buildfile location

location : \Location

inherited

var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable

inherited

var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project

inherited

var	A reference to the current project instance

Type(s)

\Project