PHPLocTask

Extends \Task

Runs phploc a tool for quickly measuring the size of PHP projects.

Use \Project#createTask to register a new Task.

package

phing.tasks.ext.phploc

author

Raphael Stolt raphael.stolt@gmail.com

Methods

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

addFileSet(\FileSet $fs) : void

Arguments

$fs

\FileSet

getCountForFiles

getCountForFiles(array<mixed,\SplFileInfo> $files) : array

Arguments

$files

array<mixed,\SplFileInfo>

Response

array

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The text description of the task

getFilesToCheck

getFilesToCheck() : array<mixed,\SplFileInfo>

Response

array<mixed,\SplFileInfo>

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

getLocation() : \Location
inherited

Response

\Location

The location object describing the position of this

             task within the buildfile.

Returns the owning target of this task.

getOwningTarget() : \Target
inherited

Response

\Target

The target object that owns this task

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns a name

getRegisterSlot(string $slotName) 
inherited

Arguments

$slotName

string

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The wrapper object used by this task

Returns the name of task, used only for log messages

getTaskName() : string
inherited

Response

string

Name of this task

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

getTaskType() : string
inherited

Response

string

The type of this task (XML Tag)

Called by the parser to let the task initialize properly.

init() 
inherited

Should throw a BuildException if something goes wrong with the build

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

throws

isFileSuffixSet

isFileSuffixSet(string $filename) : boolean

Arguments

$filename

string

Response

boolean

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

Called by the project to let the task do it's work. 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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main() 
inherited abstract

Should throw a BuildException if someting goes wrong with the build

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

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

maybeConfigure() 
inherited

Perfrom this task

perform() 
inherited

runPhpLocCheck

runPhpLocCheck() 

setCountTests

setCountTests(boolean $countTests) 

Arguments

$countTests

boolean

Sets a textual description of the task

setDescription(string $desc) 
inherited

Arguments

$desc

string

The text describing the task

setFile

setFile(\PhingFile $file) 

Arguments

$file

\PhingFile

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

setLocation(\Location $location) 
inherited

Arguments

$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

Arguments

$target

\Target

References the project to the current component.

setProject(\Project $project) 
inherited

Arguments

$project

\Project

The reference to the current project

setReportDirectory

setReportDirectory(string $directory) 

Arguments

$directory

string

setReportName

setReportName(string $name) 

Arguments

$name

string

setReportType

setReportType(string $type) 

Arguments

$type

string

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

setSuffixes

setSuffixes(string $suffixListOrSingleSuffix) 

Arguments

$suffixListOrSingleSuffix

string

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

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

setTaskType( $name) 
inherited

Arguments

$name

validateProperties

validateProperties() 
throws

Properties

suffixesToCheck

suffixesToCheck : array
var

Type(s)

array

acceptedReportTypes

acceptedReportTypes : array
var

Type(s)

array

reportDirectory

reportDirectory : null
var

Type(s)

null

reportType

reportType : string
var

Type(s)

string

reportFileName

reportFileName : string
var

Type(s)

string

countTests

countTests : boolean
var

Type(s)

boolean

fileToCheck

fileToCheck : null|\PhingFile
var

Type(s)

null|\PhingFile

filesToCheck

filesToCheck : array
var

Type(s)

array

fileSets

fileSets : array<mixed,\FileSet>
var

Type(s)

array<mixed,\FileSet>

oldVersion

oldVersion : boolean
var

Type(s)

boolean

Flag for identifying if phploc library is between version 1.7.0 and 1.7.4

isOneSevenVersion : boolean
var

Type(s)

boolean

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project