tasks/ext/phpmd/PHPMDTask.php

Show:

inherited

Classes
- \PHPMDTask

Table of Contents

\PHPMDTask
jump to top

Package: phing\tasks\ext\phpmd

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.

Default valuearray('php')Details

Type: array

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

Type: string
Inherited_from: \Task::$$description

\PhingFile
                 $file= 'null'

A php source code filename or directory

Default valuenullDetails

Type: \PhingFile

\array<FileSet>
                 $filesets= 'array()'

All fileset objects assigned to this task

Default valuearray()Details

Type: \array<FileSet>

string
                 $format= ''text''

The format for the report

Default value'text'Details

Type: string

\array<PHPMDFormatterElement>
                 $formatters= 'array()'

Formatter elements.

Default valuearray()Details

Type: \array<PHPMDFormatterElement>

array
                 $ignorePatterns= 'array('.git', '.svn', 'CVS', '.bzr', '.hg')'

List of exclude directory patterns.

Default valuearray('.git', '.svn', 'CVS', '.bzr', '.hg')Details

Type: array

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

Type: \Location
Inherited_from: \Task::$$location

integer
                 $minimumPriority= '0'

The minimum priority for rules to load.

Default value0Details

Type: integer

\Project
                 $project= 'null'

inherited

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::$$project

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$$project
Inherited_from: \Task::$$project

string
                 $rulesets= ''codesize,unusedcode''

The rule-set filenames or identifier.

Default value'codesize,unusedcode'Details

Type: string

\Target
                 $target= ''

inherited

Owning Target object

Inherited from: \Task::$$target

Details

Type: \Target
Inherited_from: \Task::$$target

string
                 $taskName= ''

inherited

Taskname for logger

Inherited from: \Task::$$taskName

Details

Type: string
Inherited_from: \Task::$$taskName

string
                 $taskType= ''

inherited

Internal taskname (req)

Inherited from: \Task::$$taskType

Details

Type: string
Inherited_from: \Task::$$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

Wrapper of the task

Inherited from: \Task::$$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$$wrapper

Methods

createFileSet(
          
          )
        
        :
          \FileSet

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

Returns

Type	Description
\FileSet	The created fileset object

createFormatter(
          
          )
        
        :
          \PHPMDFormatterElement

Create object for nested formatter element.

Returns

Type	Description
\PHPMDFormatterElement

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getLocation(
          
          )
        
        :
          \Location

inherited

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

Inherited from: \Task::getLocation()

Returns

Type	Description
\Location	The location object describing the position of this task within the buildfile.

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRegisterSlot(
          string $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName	string

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          string

inherited

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

Inherited from: \Task::getTaskType()

Returns

Type	Description
string	The type of this task (XML Tag)

inherited

Called by the parser to let the task initialize properly.

Inherited from: \Task::init()

Should throw a BuildException if something goes wrong with the build

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

Throws

Exception	Description
\BuildException

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

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.

Throws

Exception	Description
\BuildException	- if the phpmd classes can't be loaded.

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::perform()

setAllowedFileExtensions(
          string $fileExtensions
          )
        
        :
          void

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

Parameters

Name	Type	Description
$fileExtensions	string	List of valid file extensions without leading dot.

setDescription(
          string $desc
          )
        
        :
          void

inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()

Parameters

Name	Type	Description
$desc	string	The text describing the task

setFile(
          \PhingFile $file
          )
        
        :
          void

Set the input source file or directory.

Parameters

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.

Parameters

Name	Type	Description
$ignorePatterns	string	List of ignore patterns.

setLocation(
          \Location $location
          )
        
        :
          void

inherited

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

Inherited from: \Task::setLocation()

Parameters

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.

Parameters

Name	Type	Description
$minimumPriority	integer	Minimum rule priority.

setOwningTarget(
          \Target $target
          )
        
        :
          void

inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()

Parameters

Name	Type	Description
$target	\Target	Reference to owning target

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

setRulesets(
          string $ruleSetFileNames
          )
        
        :
          void

Sets the rule-sets.

Parameters

Name	Type	Description
$ruleSetFileNames	string	Comma-separated string of rule-set filenames or identifier.

setRuntimeConfigurableWrapper(
          \RuntimeConfigurable $wrapper
          )
        
        :
          void

inherited

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

Inherited from: \Task::setRuntimeConfigurableWrapper()

Parameters

Name	Type	Description
$wrapper	\RuntimeConfigurable	The wrapper object this task should use

setTaskName(
          string $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string	A string representing the name of this task for log

setTaskType(
          string $name
          )
        
        :
          void

inherited

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

Inherited from: \Task::setTaskType()

Parameters

Name	Type	Description
$name	string	The type of this task (XML Tag)

tasks/ext/phpmd/PHPMDTask.php

\PHPMDTaskjump to top

Properties

Methods

\PHPMDTask
jump to top