tasks/ext/pdepend/PhpDependTask.php
\PhpDependTask
Runs the PHP_Depend software analyzer and metric tool.
Performs static code analysis on a given source base.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Benjamin Schultz
- Copyright
- 2001,2002 THYRELL. All rights reserved
- Since
- 2.4.1
- Version
- $Id: 572bbfe2e542b864211a85de9990f5cbfe31a4cd $
Properties


\array<string>
$_allowedFileExtensions= 'array('php', 'php5')'
List of allowed file extensions. Default file extensions are <b>php</b> and <p>php5</b>.
array('php', 'php5')
Details- Type
- \array<string>


\array<PhpDependAnalyzerElement>
$_analyzers= 'array()'
Analyzer elements
array()
Details- Type
- \array<PhpDependAnalyzerElement>


\PhingFile
$_configFile= 'null'
PHP_Depend configuration file
null
Details- Type
- \PhingFile


\array<string>
$_excludeDirectories= 'array('.git', '.svn', 'CVS')'
List of exclude directories. Default exclude dirs are <b>.git</b>, <b>.svn</b> and <b>CVS</b>.
array('.git', '.svn', 'CVS')
Details- Type
- \array<string>


\array<string>
$_excludePackages= 'array()'
List of exclude packages
array()
Details- Type
- \array<string>


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


boolean
$_haltonerror= 'false'
Flag that determines whether to halt on error
false
Details- Type
- boolean


\array<PhpDependLoggerElement>
$_loggers= 'array()'
Logger elements
array()
Details- Type
- \array<PhpDependLoggerElement>


\PHP_Depend_TextUI_Runner
$_runner= 'null'
Holds the PHP_Depend runner instance
null
Details- Type
- \PHP_Depend_TextUI_Runner


boolean
$_supportBadDocumentation= 'false'
Should PHP_Depend treat <b>+global</b> as a regular project package?
false
Details- Type
- boolean


boolean
$_withoutAnnotations= 'false'
Should the parse ignore doc comment annotations?
false
Details- Type
- boolean


\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


createAnalyzer(
)
:
\PhpDependAnalyzerElement
Create object for nested analyzer element
Type | Description |
---|---|
\PhpDependAnalyzerElement |


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


createLogger(
)
:
\PhpDependLoggerElement
Create object for nested logger element
Type | Description |
---|---|
\PhpDependLoggerElement |


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_Depend
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_Depend_TextUI_Runner 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 |


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 |


setConfigFile(
\PhingFile $configFile
)
:
void
Set the configuration file
Name | Type | Description |
---|---|---|
$configFile | \PhingFile | The configuration file |


setDebug(
boolean $debug
)
:
void
Set debugging On/Off
Name | Type | Description |
---|---|---|
$debug | boolean |


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


setExcludeDirectories(
string $excludeDirectories
)
:
void
Sets a list of exclude directories
Name | Type | Description |
---|---|---|
$excludeDirectories | string | List of exclude directories |


setExcludePackages(
string $excludePackages
)
:
void
Sets a list of exclude packages
Name | Type | Description |
---|---|---|
$excludePackages | string | Exclude packages |


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


setHaltonerror(
boolean $haltonerror
)
:
void
Set halt on error
Name | Type | Description |
---|---|---|
$haltonerror | boolean |


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


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 |


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 |


setSupportBadDocumentation(
boolean $supportBadDocumentation
)
:
void
Should PHP_Depend support projects with a bad documentation. If this option is set to true, PHP_Depend will treat the default package +global as a regular project package.
Name | Type | Description |
---|---|---|
$supportBadDocumentation | boolean |


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


setWithoutAnnotations(
boolean $withoutAnnotations
)
:
void
Should the parser ignore doc comment annotations?
Name | Type | Description |
---|---|---|
$withoutAnnotations | boolean |


validateAnalyzers(
)
:
void
Validates the available analyzers
Exception | Description |
---|---|
\BuildException |


validateLoggers(
)
:
void
Validates the available loggers
Exception | Description |
---|---|
\BuildException |