Use \Project#createTask to register a new Task.
Methods
getAbbrev
getAbbrev() : integer
getAll
getAll() : boolean
getAlways
getAlways() : boolean
getCandidates
getCandidates() : integer
getCommittish
getCommittish() : string
getContains
getContains() : boolean
Returns the textual description of the task
getDescription() : string
inherited
Response
string
The text description of the task
getGitClient
getGitClient(boolean $reset = false, null $repository = null) : null|\VersionControl_Git
inherited
Arguments
Response
null|\VersionControl_Git
Get path to git executable
getGitPath() : string
inherited
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.
getLong
getLong() : boolean
getMatch
getMatch() : string
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
Get repository directory
getRepository() : string
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.
isAlways
isAlways() : boolean
isContains
isContains() : boolean
isLong
isLong() : 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.
setAbbrev
setAbbrev( $length)
setAlways
setAlways( $flag)
setCandidates
setCandidates( $count)
setCommittish
setCommittish( $object)
setContains
setContains( $flag)
Sets a textual description of the task
setDescription(string $desc)
inherited
Arguments
$desc
string
The text describing the task
Set path to git executable
setGitPath(string $gitPath) : \GitBaseTask
inherited
Arguments
$gitPath
string
New path to git repository
Response
\GitBaseTask
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.
setMatch
setMatch( $pattern)
setOutputProperty
setOutputProperty(string $prop)
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
Set repository directory
setRepository(string $repository) : \GitBaseTask
inherited
Arguments
$repository
string
Repo directory
Response
\GitBaseTask
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
inherited
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
Properties
Use any ref found in .git/refs/. See --all of git-describe
all : boolean
Find tag that contains the commit. See --contains of git-describe
contains : boolean
Use <n> digit object name. See --abbrev of git-describe
abbrev : integer
Consider up to <n> most recent tags. See --candidates of git-describe
candidates : integer
Always output the long format. See --long of git-describe
long : boolean
Only consider tags matching the given pattern. See --match of git-describe
match : string
Show uniquely abbreviated commit object as fallback. See --always of git-describe
always : boolean
<committish> argument to git-describe
committish : string
Property name to set with output value from git-describe
outputProperty : string
Bath to git binary
gitPath : string
inherited
gitClient
gitClient : \VersionControl_Git
inherited
Type(s)
\VersionControl_Git
Current repository directory
repository : string
inherited
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