tasks/ext/pdepend/PhpDependTask.php

Show:

inherited

Classes
- \PhpDependTask

Table of Contents

$Id: PhpDependTask.php 1038 2011-02-08 12:22:02Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

\PhpDependTask
jump to top

Package: phing\tasks\ext\pdepend

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
Since: 2.4.1
Version: $Id: PhpDependTask.php 1038 2011-02-08 12:22:02Z mrook $

Properties

\array<string>
                 $_allowedFileExtensions= 'array('php''

List of allowed file extensions. Default file extensions are php and php5.

Default valuearray('php'Details

Type: \array<string>

\array<PhpDependAnalyzerElement>
                 $_analyzers= 'array()'

Analyzer elements

Default valuearray()Details

Type: \array<PhpDependAnalyzerElement>

\PhingFile
                 $_configFile= 'null'

PHP_Depend configuration file

Default valuenullDetails

Type: \PhingFile

boolean
                 $_debug= 'false'

Flag for enable/disable debugging

Default valuefalseDetails

Type: boolean

\array<string>
                 $_excludeDirectories= 'array('.git''

List of exclude directories. Default exclude dirs are .git, .svn and CVS.

Default valuearray('.git'Details

Type: \array<string>

\array<string>
                 $_excludePackages= 'array()'

List of exclude packages

Default valuearray()Details

Type: \array<string>

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

boolean
                 $_haltonerror= 'false'

Flag that determines whether to halt on error

Default valuefalseDetails

Type: boolean

\array<PhpDependLoggerElement>
                 $_loggers= 'array()'

Logger elements

Default valuearray()Details

Type: \array<PhpDependLoggerElement>

\PHP_Depend_TextUI_Runner
                 $_runner= 'null'

Holds the PHP_Depend runner instance

Default valuenullDetails

Type: \PHP_Depend_TextUI_Runner

boolean
                 $_supportBadDocumentation= 'false'

Should PHP_Depend treat +global as a regular project package?

Default valuefalseDetails

Type: boolean

boolean
                 $_withoutAnnotations= 'false'

Should the parse ignore doc comment annotations?

Default valuefalseDetails

Type: boolean

Methods

createAnalyzer(
          
          )
        
        :
          \PhpDependAnalyzerElement

Create object for nested analyzer element

Returns

Type	Description
\PhpDependAnalyzerElement

createFileSet(
          
          )
        
        :
          \FileSet

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

Returns

Type	Description
\FileSet	The created fileset object

createLogger(
          
          )
        
        :
          \PhpDependLoggerElement

Create object for nested logger element

Returns

Type	Description
\PhpDependLoggerElement

getDescription(
          
          )
        
        :
          void

getLocation(
          
          )
        
        :
          void

getOwningTarget(
          
          )
        
        :
          void

getProject(
          
          )
        
        :
          void

getRegisterSlot(
          
          )
        
        :
          void

getRuntimeConfigurableWrapper(
          
          )
        
        :
          void

getTaskName(
          
          )
        
        :
          void

getTaskType(
          
          )
        
        :
          void

Load the necessary environment for running PHP_Depend

Throws

Exception	Description
\BuildException

Executes PHP_Depend_TextUI_Runner against PhingFile or a FileSet

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

perform(
          
          )
        
        :
          void

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

setConfigFile(
          \PhingFile $configFile
          )
        
        :
          void

Set the configuration file

Parameters

Name	Type	Description
$configFile	\PhingFile	The configuration file

setDebug(
          boolean $debug
          )
        
        :
          void

Set debugging On/Off

Parameters

Name	Type	Description
$debug	boolean

setDescription(
          
          )
        
        :
          void

setExcludeDirectories(
          string $excludeDirectories
          )
        
        :
          void

Sets a list of exclude directories

Parameters

Name	Type	Description
$excludeDirectories	string	List of exclude directories

setExcludePackages(
          string $excludePackages
          )
        
        :
          void

Sets a list of exclude packages

Parameters

Name	Type	Description
$excludePackages	string	Exclude packages

setFile(
          \PhingFile $file
          )
        
        :
          void

Set the input source file or directory

Parameters

Name	Type	Description
$file	\PhingFile	The input source file or directory

setHaltonerror(
          boolean $haltonerror
          )
        
        :
          void

Set halt on error

Parameters

Name	Type	Description
$haltonerror	boolean

setLocation(
          
          )
        
        :
          void

setOwningTarget(
          
          )
        
        :
          void

setProject(
          
          )
        
        :
          void

setRuntimeConfigurableWrapper(
          
          )
        
        :
          void

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.

Parameters

Name	Type	Description
$supportBadDocumentation	boolean

setTaskName(
          
          )
        
        :
          void

setTaskType(
          
          )
        
        :
          void

setWithoutAnnotations(
          boolean $withoutAnnotations
          )
        
        :
          void

Should the parser ignore doc comment annotations?

Parameters

Name	Type	Description
$withoutAnnotations	boolean

validateAnalyzers(
          
          )
        
        :
          void

Validates the available analyzers

Throws

Exception	Description
\BuildException

validateLoggers(
          
          )
        
        :
          void

Validates the available loggers

Throws

Exception	Description
\BuildException

tasks/ext/pdepend/PhpDependTask.php

\PhpDependTaskjump to top

Properties

Methods

\PhpDependTask
jump to top