tasks/system/CvsTask.php
Classes
\CvsTask
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.
- Parent(s)
- \Task < \ProjectComponent
- Author
- Hans Lellelid
- Author
- costin@dnt.ro (Ant)
- Author
- stefano@apache.org (Ant)
- Author
- Wolfgang Werner
- Author
- Kevin Ross
- Version
- $Revision: 1311 $
Constants
DEFAULT_COMPRESSION_LEVEL
= 3Default compression level to use, if compression is enabled via setCompression( true ).
Properties
$cmd= ''
- Type
- n/a
$command= 'null'
the CVS command to execute.
nullDetails- Type
- n/a
array
$commandlines= 'array()'
List of Commandline children
Commandline[]array()Details- Type
- array
$compression= '0'
compression level to use.
0Details- Type
- n/a
$cvsModule= ''
the package/module to check out.
- Type
- n/a
$cvsRoot= ''
the CVSROOT variable.
- Type
- n/a
$cvsRsh= ''
the CVS_RSH variable.
- Type
- n/a
$default_command= '"checkout"'
the default command.
"checkout"Details- Type
- n/a
\File
$dest= ''
the directory where the checked out files should be placed.
- Type
- \File
$error= ''
- Type
- n/a
boolean
$failOnError= 'false'
If true it will stop the build if cvs exits with error.
Default is false. (Iulian)
falseDetails- Type
- boolean
$noexec= 'false'
report only, don't change any files.
falseDetails- Type
- n/a
$output= ''
- Type
- n/a
\File
$passFile= 'null'
CVS password file
nullDetails- Type
- \File
$port= '0'
CVS port
0Details- Type
- n/a
$quiet= 'false'
suppress information messages.
falseDetails- Type
- n/a
Methods
addConfiguredCommandline(
\insertAtStart $c, $insertAtStart
=
false
)
:
voidConfigures and adds the given Commandline.
| Name | Type | Description |
|---|---|---|
| $c | \insertAtStart | If true, c is |
| $insertAtStart |
appendCommandArgument(
$arg
)
:
voidThis needs to be public to allow configuration of commands externally.
| Name | Type | Description |
|---|---|---|
| $arg |
configureCommandline(
$c
)
:
stringConfigure a commandline element for things like cvsRoot, quiet, etc.
| Name | Type | Description |
|---|---|---|
| $c |
| Type | Description |
|---|---|
| string |
getCommand(
)
:
voidgetCvsRoot(
)
:
voidgetCvsRsh(
)
:
voidgetDescription(
)
:
voidgetDest(
)
:
voidgetLocation(
)
:
voidgetModule(
)
:
voidgetOwningTarget(
)
:
voidgetPassFile(
)
:
\File| Type | Description |
|---|---|
| \File |
getPort(
)
:
int| Type | Description |
|---|---|
| int |
getProject(
)
:
voidgetRegisterSlot(
)
:
voidgetRuntimeConfigurableWrapper(
)
:
voidgetTaskName(
)
:
voidgetTaskType(
)
:
voidinit(
)
:
voidlog(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidremoveCommandline(
$c
)
:
void| Name | Type | Description |
|---|---|---|
| $c |
runCommand(
\Commandline $toExecute
)
:
voidSets up the environment for toExecute and then runs it.
| Name | Type | Description |
|---|---|---|
| $toExecute | \Commandline |
| Exception | Description |
|---|---|
| \BuildException |
setCommand(
string $c
)
:
voidThe CVS command to execute.
| Name | Type | Description |
|---|---|---|
| $c | string |
setCompression(
boolean $usecomp
)
:
voidIf true, this is the same as compressionlevel="3".
| Name | Type | Description |
|---|---|---|
| $usecomp | boolean | If true, turns on compression using default level, AbstractCvsTask.DEFAULT_COMPRESSION_LEVEL. |
setCompressionLevel(
int $level
)
:
voidIf set to a value 1-9 it adds -zN to the cvs command line, else it disables compression.
| Name | Type | Description |
|---|---|---|
| $level | int |
setCvsRoot(
string $root
)
:
voidThe CVSROOT variable.
| Name | Type | Description |
|---|---|---|
| $root | string |
setCvsRsh(
$rsh
)
:
voidThe CVS_RSH variable.
| Name | Type | Description |
|---|---|---|
| $rsh | rsh |
setDate(
$p
)
:
voidUse the most recent revision no later than the given date.
| Name | Type | Description |
|---|---|---|
| $p | p |
setDescription(
)
:
voidsetDest(
\PhingFile $dest
)
:
voidThe directory where the checked out files should be placed.
| Name | Type | Description |
|---|---|---|
| $dest | \PhingFile |
setError(
$f
)
:
voidFile to which error output should be written.
| Name | Type | Description |
|---|---|---|
| $f |
setFailOnError(
boolean $failOnError
)
:
voidStop the build process if the command exits with a return code other than 0.
Defaults to false.
| Name | Type | Description |
|---|---|---|
| $failOnError | boolean |
setLocation(
)
:
voidsetModule(
$m
)
:
voidThe package/module to operate upon.
| Name | Type | Description |
|---|---|---|
| $m |
setNoexec(
boolean $ne
)
:
voidIf true, report only and don't change any files.
| Name | Type | Description |
|---|---|---|
| $ne | boolean |
setOutput(
$f
)
:
voidFile to which output should be written.
| Name | Type | Description |
|---|---|---|
| $f |
setOwningTarget(
)
:
voidsetPassfile(
$passFile
)
:
voidPassword file to read passwords from.
| Name | Type | Description |
|---|---|---|
| $passFile | passFile |
setPort(
int $port
)
:
voidPort used by CVS to communicate with the server.
| Name | Type | Description |
|---|---|---|
| $port | int |
setProject(
)
:
voidsetQuiet(
boolean $q
)
:
voidIf true, suppress informational messages.
| Name | Type | Description |
|---|---|---|
| $q | boolean |
setRuntimeConfigurableWrapper(
)
:
voidsetTag(
string $p
)
:
voidThe tag of the package/module to operate upon.
| Name | Type | Description |
|---|---|---|
| $p | string |
setTaskName(
)
:
voidsetTaskType(
)
:
void