Methods
Returns the textual description of the task
getDescription() : string
Inherited
| inherited_from |
\Task::getDescription() |
| inherited_from |
\GitBaseTask::getDescription() |
Returns
stringThe text description of the task
getDestination()
getDestination()
Get path to git executable
getGitPath() : string
Inherited
| inherited_from |
\GitBaseTask::getGitPath() |
Returns
string
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
| inherited_from |
\Task::getLocation() |
| inherited_from |
\GitBaseTask::getLocation() |
Returns
\LocationThe location object describing the position of this
task within the buildfile.
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
| inherited_from |
\Task::getOwningTarget() |
| inherited_from |
\GitBaseTask::getOwningTarget() |
Returns
\TargetThe target object that owns this task
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\Task::getProject() |
| inherited_from |
\GitBaseTask::getProject() |
Returns
\ProjectReference to current porject object
getRefspec()
getRefspec()
Get repository directory
getRepository() : string
Inherited
| inherited_from |
\GitBaseTask::getRepository() |
Returns
string
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::getRuntimeConfigurableWrapper() |
| inherited_from |
\GitBaseTask::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
| inherited_from |
\Task::getTaskName() |
| inherited_from |
\GitBaseTask::getTaskName() |
Returns
stringName of this task
Returns the name of the task under which it was invoked,
usually the XML tagname
getTaskType() : string
Inherited
| inherited_from |
\Task::getTaskType() |
| inherited_from |
\GitBaseTask::getTaskType() |
Returns
stringThe type of this task (XML Tag)
Initialize Task.
init()
Inherited
Check and include necessary libraries.
| inherited_from |
\GitBaseTask::init() |
Exceptions
isAllRemotes()
isAllRemotes()
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
stringThe message to log
$level
integerThe priority of the message
The main entry point for the task
main()
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
phing target1 target2 will run all tasks in target3 twice.
Should throw a BuildException if someting goes wrong with the build
This is abstract here. Must be overloaded by real tasks.
setDelete()
setDelete($flag)
Sets a textual description of the task
setDescription(string $desc)
Inherited
| inherited_from |
\Task::setDescription() |
| inherited_from |
\GitBaseTask::setDescription() |
Parameters
$desc
stringThe text describing the task
setDestination()
setDestination($destination)
setForce()
setForce($flag)
Set path to git executable
setGitPath(string $gitPath) : \GitBaseTask
Inherited
| inherited_from |
\GitBaseTask::setGitPath() |
Parameters
$gitPath
stringNew path to git repository
Returns
Sets the location within the buildfile this task occurs.
setLocation(\Location $location)
Inherited
Called by
the parser to set location information.
| inherited_from |
\Task::setLocation() |
| inherited_from |
\GitBaseTask::setLocation() |
Parameters
$location
\LocationThe location object describing the position of this
task within the buildfile.
setMirror()
setMirror($flag)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
| inherited_from |
\Task::setOwningTarget() |
| inherited_from |
\GitBaseTask::setOwningTarget() |
Parameters
$target
\TargetReference to owning target
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\Task::setProject() |
| inherited_from |
\GitBaseTask::setProject() |
Parameters
$project
\ProjectThe reference to the current project
setQuiet()
setQuiet($flag)
setRefspec()
setRefspec($spec)
Set repository directory
setRepository(string $repository) : \GitBaseTask
Inherited
| inherited_from |
\GitBaseTask::setRepository() |
Parameters
$repository
stringRepo directory
Returns
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
| inherited_from |
\Task::setRuntimeConfigurableWrapper() |
| inherited_from |
\GitBaseTask::setRuntimeConfigurableWrapper() |
Parameters
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
| inherited_from |
\Task::setTaskName() |
| inherited_from |
\GitBaseTask::setTaskName() |
Parameters
$name
string
Returns
stringA string representing the name of this task for log
Sets the type of the task.
setTaskType(string $name)
Inherited
Usually this is the name of the XML tag
| inherited_from |
\Task::setTaskType() |
| inherited_from |
\GitBaseTask::setTaskType() |
Parameters
$name
stringThe type of this task (XML Tag)
getGitClient()
getGitClient($reset, $repository)
Inherited
| inherited_from |
\GitBaseTask::getGitClient() |
Parameters
$reset
$repository
Returns a name
getRegisterSlot(string $slotName)
Inherited
| inherited_from |
\Task::getRegisterSlot() |
| inherited_from |
\GitBaseTask::getRegisterSlot() |
Parameters
$slotName
string
Properties
$description : string
Inherited
| inherited_from |
\Task::$$description |
| inherited_from |
\GitBaseTask::$$description |
$location : \Location
Inherited
| inherited_from |
\Task::$$location |
| inherited_from |
\GitBaseTask::$$location |
$project : \Project
Inherited
| inherited_from |
\ProjectComponent::$$project |
| inherited_from |
\Task::$$project |
| inherited_from |
\GitBaseTask::$$project |
$target : \Target
Inherited
| inherited_from |
\Task::$$target |
| inherited_from |
\GitBaseTask::$$target |
$taskName : string
Inherited
| inherited_from |
\Task::$$taskName |
| inherited_from |
\GitBaseTask::$$taskName |
$taskType : string
Inherited
| inherited_from |
\Task::$$taskType |
| inherited_from |
\GitBaseTask::$$taskType |
$wrapper : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::$$wrapper |
| inherited_from |
\GitBaseTask::$$wrapper |
$gitClient : \VersionControl_Git
Inherited
| inherited_from |
\GitBaseTask::$$gitClient |
$gitPath : string
Inherited
| inherited_from |
\GitBaseTask::$$gitPath |
$repository : string
Inherited
| inherited_from |
\GitBaseTask::$$repository |