Runs phploc a tool for quickly measuring the size of PHP projects.
Use \Project#createTask to register a new Task.
Methods
Nested adder, adds a set of files (nested fileset attribute).
addFileSet(\FileSet $fs) : void
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) : \RegisterSlot
inherited
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited
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.
isFileSuffixSet
isFileSuffixSet(string $filename) : boolean
Arguments
Response
boolean
Logs a message with the given priority.
log(string $msg, integer $level = \Project::MSG_INFO) : void
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.
runPhpLocCheck
runPhpLocCheck()
setCountTests
setCountTests(boolean $countTests)
Sets a textual description of the task
setDescription(string $desc)
inherited
Arguments
$desc
string
The text describing the task
setFile
setFile(\PhingFile $file)
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
References the project to the current component.
setProject(\Project $project) : void
inherited
Arguments
$project
\Project
The reference to the current project
setReportDirectory
setReportDirectory(string $directory)
setReportName
setReportName(string $name)
setReportType
setReportType(string $type)
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited
setSuffixes
setSuffixes(string $suffixListOrSingleSuffix)
Arguments
$suffixListOrSingleSuffix
string
Sets the name of this task for log messages
setTaskName(string $name) : string
inherited
Arguments
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
validateProperties
validateProperties()
Properties
suffixesToCheck
suffixesToCheck : array
acceptedReportTypes
acceptedReportTypes : array
reportDirectory
reportDirectory : null
reportType
reportType : string
reportFileName
reportFileName : string
countTests
countTests : boolean
fileToCheck
fileToCheck : null|\PhingFile
filesToCheck
filesToCheck : array
fileSets
fileSets : array<mixed,\FileSet>
oldVersion
oldVersion : boolean
Flag for identifying if phploc library is between version 1.7.0 and 1.7.4
isOneSevenVersion : boolean
Owning Target object
target : \Target
inherited
Description of the task
description : string
inherited
Internal taskname (req)
taskType : string
inherited
Taskname for logger
taskName : string
inherited
Stored buildfile location
location : \Location
inherited
Wrapper of the task
wrapper : \RuntimeConfigurable
inherited
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