tasks/ext/phpcpd/PHPCPDTask.php

Show:

inherited

Classes
- \PHPCPDTask

Table of Contents

\PHPCPDTask
jump to top

Package: phing\tasks\ext\phpcpd

Runs PHP Copy & Paste Detector. Checking PHP files for duplicated code.

Refactored original PhpCpdTask provided by Timo Haberkern timo.haberkern@fantastic-bits.de

Parent(s): \Task < \ProjectComponent
Author: Benjamin Schultz
Copyright: 2001,2002 THYRELL. All rights reserved
Version: $Id: 8fbff39b2ca68e97afd59d5dc6d5a37c3678624e $

Properties

array
                 $_allowedFileExtensions= 'array('php')'

List of valid file extensions for analyzed files.

Default valuearray('php')Details

Type: array

\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= ''default''

The format for the report

Default value'default'Details

Type: string

\array<PHPCPDFormatterElement>
                 $_formatters= 'array()'

Formatter elements.

Default valuearray()Details

Type: \array<PHPCPDFormatterElement>

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

List of exclude directory patterns.

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

Type: array

integer
                 $_minLines= '5'

Minimum number of identical lines.

Default value5Details

Type: integer

integer
                 $_minTokens= '70'

Minimum number of identical tokens.

Default value70Details

Type: integer

string
                 $description= ''

inherited

Description of the task

Inherited from: \Task::$$description

Details

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

\Location
                 $location= ''

inherited

Stored buildfile location

Inherited from: \Task::$$location

Details

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

\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

\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

addFileSet(
          \FileSet $fs
          )
        
        :
          void

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

Parameters

Name	Type	Description
$fs	\FileSet	List of files to scan

createFormatter(
          
          )
        
        :
          \PHPCPDFormatterElement

Create object for nested formatter element.

Returns

Type	Description
\PHPCPDFormatterElement

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)

Load the necessary environment for running PHPCPD.

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	- if the phpcpd classes can't be loaded.

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

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.

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.

setFormat(
          string $format
          )
        
        :
          void

Sets the output format

Parameters

Name	Type	Description
$format	string	Format of the report

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.

setMinLines(
          integer $minLines
          )
        
        :
          void

Sets the minimum number of identical lines (default: 5).

Parameters

Name	Type	Description
$minLines	integer	Minimum number of identical lines

setMinTokens(
          integer $minTokens
          )
        
        :
          void

Sets the minimum number of identical tokens (default: 70).

Parameters

Name	Type	Description
$minTokens	integer	Minimum number of identical tokens

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

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)

validateFormatters(
          
          )
        
        :
          void

Validates the available formatters

Throws

Exception	Description
\BuildException

tasks/ext/phpcpd/PHPCPDTask.php

\PHPCPDTaskjump to top

Properties

Methods

\PHPCPDTask
jump to top