Methods
Returns the textual description of the task
getDescription() : string
Inherited
inherited_from |
\Task::getDescription() |
Returns
string
The text description of the task
Returns the force switch
getForce()
Returns the ignore-externals switch
getIgnoreExternals()
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
inherited_from |
\Task::getLocation() |
Returns
\Location
The location object describing the position of this
task within the buildfile.
Returns the no-auth-cache switch
getNoCache()
Returns the owning target of this task.
getOwningTarget() : \Target
Inherited
inherited_from |
\Task::getOwningTarget() |
Returns
\Target
The target object that owns this task
Returns the password
getPassword()
Returns a reference to current project
getProject() : \Project
Inherited
inherited_from |
\ProjectComponent::getProject() |
inherited_from |
\Task::getProject() |
Returns
\Project
Reference to current porject object
Returns the non-recursive switch
getRecursive()
Returns the path/URI to the repository
getRepositoryUrl()
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the path to the SVN executable
getSvnPath()
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
inherited_from |
\Task::getTaskName() |
Returns
string
Name 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() |
Returns
string
The type of this task (XML Tag)
Returns the path to export/checkout to
getToDir()
Returns the trust-server-cert switch
getTrustServerCert()
Returns the username
getUsername()
Returns the path to the workingcopy
getWorkingCopy()
Initialize Task.
init()
This method includes any necessary SVN libraries and triggers
appropriate error if they cannot be found. This is not done in header
because we may want this class to be loaded w/o triggering an error.
Exceptions
Provides a project level log event to the task.
log(string $msg, integer $level)
Inherited
Parameters
$msg
string
The message to log
$level
integer
The priority of the message
Called by the project to let the task do it's work.
main()
Inherited
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.
inherited_from |
\Task::main() |
Sets a textual description of the task
setDescription(string $desc)
Inherited
inherited_from |
\Task::setDescription() |
Parameters
$desc
string
The text describing the task
Sets the force switch
setForce($value)
Sets the ignore-externals switch
setIgnoreExternals($value)
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() |
Parameters
$location
\Location
The location object describing the position of this task within the buildfile.
Sets the no-auth-cache switch
setNoCache($value)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\Target
Reference to owning target
Sets the password of the user to export
setPassword($value)
References the project to the current component.
setProject(\Project $project)
Inherited
inherited_from |
\ProjectComponent::setProject() |
inherited_from |
\Task::setProject() |
Parameters
$project
\Project
The reference to the current project
Sets the non-recursive switch
setRecursive($value)
Sets the path/URI to the repository
setRepositoryUrl($repositoryUrl)
Parameters
$repositoryUrl
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
Sets the path to the SVN executable
setSvnPath($svnPath)
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
inherited_from |
\Task::setTaskName() |
Parameters
$name
string
Returns
string
A 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() |
Parameters
$name
string
The type of this task (XML Tag)
Sets the path to export/checkout to
setToDir($toDir)
Sets the trust-server-cert switch
setTrustServerCert($value)
Sets the username of the user to export
setUsername($value)
Sets the path to the workingcopy
setWorkingCopy($workingCopy)
Returns a name
getRegisterSlot(string $slotName)
Inherited
inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
Executes the constructed VersionControl_SVN instance
run(array $args, array $switches) : string
Parameters
$args
array
Additional arguments to pass to SVN.
$switches
array
Switches to pass to SVN.
Returns
string
Output generated by SVN.
Creates a VersionControl_SVN class based on $mode
setup(string $mode)
Parameters
$mode
string
The SVN mode to use (info, export, checkout, ...)
Exceptions
Properties
$description : string
Inherited
inherited_from |
\Task::$$description |
$location : \Location
Inherited
inherited_from |
\Task::$$location |
$project : \Project
Inherited
inherited_from |
\ProjectComponent::$$project |
inherited_from |
\Task::$$project |
$target : \Target
Inherited
inherited_from |
\Task::$$target |
$taskName : string
Inherited
inherited_from |
\Task::$$taskName |
$taskType : string
Inherited
inherited_from |
\Task::$$taskType |