Task for performing CVS operations.
NOTE: This implementation has been moved here from Cvs.java with
the addition of some accessors for extensibility. Another task
can extend this with some customized output processing.
Methods
This needs to be public to allow configuration
of commands externally.
appendCommandArgument($arg)
getCommand()
getCommand()
getCvsRoot()
getCvsRoot()
Returns the textual description of the task
getDescription() : string
Inherited
| inherited_from |
\Task::getDescription() |
Returns
stringThe text description of the task
Returns the location within the buildfile this task occurs.
getLocation() : \Location
Inherited
| inherited_from |
\Task::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() |
Returns
\TargetThe target object that owns this task
getPassFile()
getPassFile() : \File
getPort()
getPort() : int
Returns a reference to current project
getProject() : \Project
Inherited
| inherited_from |
\ProjectComponent::getProject() |
| inherited_from |
\Task::getProject() |
Returns
\ProjectReference to current porject object
Returns the wrapper object for runtime configuration
getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
| inherited_from |
\Task::getRuntimeConfigurableWrapper() |
Returns
Returns the name of task, used only for log messages
getTaskName() : string
Inherited
| inherited_from |
\Task::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() |
Returns
stringThe type of this task (XML Tag)
Called by the parser to let the task initialize properly.
init()
Should throw a BuildException if something goes wrong with the build
This is abstract here, but may not be overloaded by subclasses.
Exceptions
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
Called by the project to let the task do it's work.
main() : void
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.
Exceptions
The CVS command to execute.
setCommand(string $c)
If true, this is the same as compressionlevel="3".
setCompression(boolean $usecomp)
Parameters
$usecomp
booleanIf true, turns on compression using default
level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL.
If set to a value 1-9 it adds -zN to the cvs command line, else
it disables compression.
setCompressionLevel(int $level)
The CVSROOT variable.
setCvsRoot(string $root)
The CVS_RSH variable.
setCvsRsh(\rsh $rsh)
Use the most recent revision no later than the given date.
setDate(\p $p)
Sets a textual description of the task
setDescription(string $desc)
Inherited
| inherited_from |
\Task::setDescription() |
Parameters
$desc
stringThe text describing the task
The directory where the checked out files should be placed.
setDest(\PhingFile $dest)
File to which error output should be written.
setError(\PhingFile $f)
Stop the build process if the command exits with
a return code other than 0.
setFailOnError(boolean $failOnError)
Parameters
$failOnError
boolean
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
\LocationThe location object describing the position of this
task within the buildfile.
The package/module to operate upon.
setModule($m)
If true, report only and don't change any files.
setNoexec(boolean $ne)
File to which output should be written.
setOutput(\PhingFile $f)
Sets the owning target this task belongs to.
setOwningTarget(\Target $target)
Inherited
| inherited_from |
\Task::setOwningTarget() |
Parameters
$target
\TargetReference to owning target
Password file to read passwords from.
setPassfile(\PhingFile $passFile)
Parameters
$passFile
\passFile
Port used by CVS to communicate with the server.
setPort(int $port)
References the project to the current component.
setProject(\Project $project)
Inherited
| inherited_from |
\ProjectComponent::setProject() |
| inherited_from |
\Task::setProject() |
Parameters
$project
\ProjectThe reference to the current project
If true, suppress informational messages.
setQuiet(boolean $q)
Sets the wrapper object this task should use for runtime
configurable elements.
setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper)
Inherited
| inherited_from |
\Task::setRuntimeConfigurableWrapper() |
Parameters
The tag of the package/module to operate upon.
setTag(string $p)
Sets the name of this task for log messages
setTaskName(string $name) : string
Inherited
| inherited_from |
\Task::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() |
Parameters
$name
stringThe type of this task (XML Tag)
Returns a name
getRegisterSlot(string $slotName)
Inherited
| inherited_from |
\Task::getRegisterSlot() |
Parameters
$slotName
string
removeCommandline()
removeCommandline(\Commandline $c)
Sets up the environment for toExecute and then runs it.
runCommand(\Commandline $toExecute)
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 |
$failOnError : boolean
Default is false. (Iulian)
Constants
Default compression level to use, if compression is enabled via
setCompression( true ).
DEFAULT_COMPRESSION_LEVEL