Runs the PHP_Depend software analyzer and metric tool.

Performs static code analysis on a given source base.

package | phing.tasks.ext.pdepend
author | Benjamin Schultz
version | $Id: 572bbfe2e542b864211a85de9990f5cbfe31a4cd $
since | 2.4.1
copyright | 2001,2002 THYRELL. All rights reserved

### Methods

## Create object for nested analyzer element

    createAnalyzer() : \PhpDependAnalyzerElement

### Returns

`\PhpDependAnalyzerElement`

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

    createFileSet() : \FileSet

### Returns

`\FileSet`The created fileset object

## Create object for nested logger element

    createLogger() : \PhpDependLoggerElement

### Returns

`\PhpDependLoggerElement`

## Returns the textual description of the task

    getDescription() : string

Inherited

inherited_from | \Task::getDescription()

### Returns

`string`The text description of the task

## Returns the location within the buildfile this task occurs.

    getLocation() : \Location

Inherited

Used by BuildException to give detailed error messages.

inherited_from | \Task::getLocation()

### Returns

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

## Returns the owning target of this task.

    getOwningTarget() : \Target

Inherited

inherited_from | \Task::getOwningTarget()

### Returns

`\Target`The target object that owns this task

## Returns a reference to current project

    getProject() : \Project

Inherited

inherited_from | \ProjectComponent::getProject()
inherited_from | \Task::getProject()

### Returns

`\Project`Reference to current porject object

## Returns the wrapper object for runtime configuration

    getRuntimeConfigurableWrapper() : \RuntimeConfigurable

Inherited

inherited_from | \Task::getRuntimeConfigurableWrapper()

### Returns

`\RuntimeConfigurable`The wrapper object used by this task

## Returns the name of task, used only for log messages

    getTaskName() : string

Inherited

inherited_from | \Task::getTaskName()

### Returns

`string`Name of this task

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

    getTaskType() : string

Inherited

inherited_from | \Task::getTaskType()

### Returns

`string`The type of this task (XML Tag)

## Load the necessary environment for running PHP_Depend

    init() : void

Should throw a BuildException if something goes wrong with the build

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

### Exceptions

`\BuildException` |

## Provides a project level log event to the task.

    log(string $msg, integer $level)

Inherited

see | \global\BuildEvent
see | \global\BuildListener
inherited_from | \Task::log()

### Parameters

#### $msg

`string`

The message to log

#### $level

`integer`

The priority of the message

## Executes PHP_Depend_TextUI_Runner against PhingFile or a FileSet

    main() : void

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 phing target1 target2 will run all tasks in target3 twice.

Should throw a BuildException if someting goes wrong with the build

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

### Exceptions

`\BuildException` |

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

    maybeConfigure()

Inherited

inherited_from | \Task::maybeConfigure()

## Perfrom this task

    perform()

Inherited

inherited_from | \Task::perform()

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

    setAllowedFileExtensions(string $fileExtensions) : void

### Parameters

#### $fileExtensions

`string`

List of valid file extensions

## Set the configuration file

    setConfigFile(\PhingFile $configFile) : void

### Parameters

#### $configFile

`\PhingFile`

The configuration file

## Set debugging On/Off

    setDebug(boolean $debug) : void

### Parameters

#### $debug

`boolean`

## Sets a textual description of the task

    setDescription(string $desc)

Inherited

inherited_from | \Task::setDescription()

### Parameters

#### $desc

`string`

The text describing the task

## Sets a list of exclude directories

    setExcludeDirectories(string $excludeDirectories) : void

### Parameters

#### $excludeDirectories

`string`

List of exclude directories

## Sets a list of exclude packages

    setExcludePackages(string $excludePackages) : void

### Parameters

#### $excludePackages

`string`

Exclude packages

## Set the input source file or directory

    setFile(\PhingFile $file) : void

### Parameters

#### $file

`\PhingFile`

The input source file or directory

## Set halt on error

    setHaltonerror(boolean $haltonerror) : void

### Parameters

#### $haltonerror

`boolean`

## Sets the location within the buildfile this task occurs.

    setLocation(\Location $location)

Inherited

Called by the parser to set location information.

inherited_from | \Task::setLocation()

### Parameters

#### $location

`\Location`

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

## Sets the owning target this task belongs to.

    setOwningTarget(\Target $target)

Inherited

inherited_from | \Task::setOwningTarget()

### Parameters

#### $target

`\Target`

Reference to owning target

## References the project to the current component.

    setProject(\Project $project)

Inherited

inherited_from | \ProjectComponent::setProject()
inherited_from | \Task::setProject()

### Parameters

#### $project

`\Project`

The reference to the current project

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

    setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)

Inherited

inherited_from | \Task::setRuntimeConfigurableWrapper()

### Parameters

#### $wrapper

`\RuntimeConfigurable`

The wrapper object this task should use

## Should PHP_Depend support projects with a bad documentation.

    setSupportBadDocumentation(boolean $supportBadDocumentation) : void

If this option is set to true, PHP_Depend will treat the default package +global as a regular project package.

### Parameters

#### $supportBadDocumentation

`boolean`

## Sets the name of this task for log messages

    setTaskName(string $name) : string

Inherited

inherited_from | \Task::setTaskName()

### Parameters

#### $name

`string`

### Returns

`string`A string representing the name of this task for log

## Sets the type of the task.

    setTaskType(string $name)

Inherited

Usually this is the name of the XML tag

inherited_from | \Task::setTaskType()

### Parameters

#### $name

`string`

The type of this task (XML Tag)

## Should the parser ignore doc comment annotations?

    setWithoutAnnotations(boolean $withoutAnnotations) : void

### Parameters

#### $withoutAnnotations

`boolean`

## Returns a name

    getRegisterSlot(string $slotName)

Inherited

inherited_from | \Task::getRegisterSlot()

### Parameters

#### $slotName

`string`

## Validates the available analyzers

    validateAnalyzers() : void

### Exceptions

`\BuildException` |

## Validates the available loggers

    validateLoggers() : void

### Exceptions

`\BuildException` |

### Properties

##

    $_allowedFileExtensions : \array<string>

Default file extensions are php and

<

p>php5.

##

    $_analyzers : \array<PhpDependAnalyzerElement>

##

    $_configFile : \PhingFile

##

    $_debug : boolean

##

    $_excludeDirectories : \array<string>

Default exclude dirs are .git, .svn and CVS.

##

    $_excludePackages : \array<string>

##

    $_file : \PhingFile

##

    $_filesets : \array<FileSet>

##

    $_haltonerror : boolean

##

    $_loggers : \array<PhpDependLoggerElement>

##

    $_runner : \PHP_Depend_TextUI_Runner

##

    $_supportBadDocumentation : boolean

##

    $_withoutAnnotations : boolean

##

    $description : string

Inherited

inherited_from | \Task::$$description

##

    $location : \Location

Inherited

inherited_from | \Task::$$location

##

    $project : \Project

Inherited

inherited_from | \ProjectComponent::$$project
inherited_from | \Task::$$project

##

    $target : \Target

Inherited

inherited_from | \Task::$$target

##

    $taskName : string

Inherited

inherited_from | \Task::$$taskName

##

    $taskType : string

Inherited

inherited_from | \Task::$$taskType

##

    $wrapper : \RuntimeConfigurable

Inherited

inherited_from | \Task::$$wrapper