tasks/ext/svn/SvnBaseTask.php
inherited
Classes
Base class for Subversion tasks
- Author
- Michiel Rook
- Author
- Andrew Eddie
- Package
- phing.tasks.ext.svn
- See
- \VersionControl_SVN
- Since
- 2.2.0
- Version
- $Id: SvnBaseTask.php 1391 2011-12-17 14:42:15Z mrook $
\SvnBaseTask
Base class for Subversion tasks
- Parent(s)
- \Task < \ProjectComponent
- Children
- \SvnCopyTask
- \SvnLogTask
- \SvnSwitchTask
- \SvnCheckoutTask
- \SvnListTask
- \SvnCommitTask
- \SvnExportTask
- \SvnUpdateTask
- \SvnLastRevisionTask
- See
- \VersionControl_SVN
- Author
- Michiel Rook
- Author
- Andrew Eddie
- Since
- 2.2.0
- Version
- $Id: SvnBaseTask.php 1391 2011-12-17 14:42:15Z mrook $
Properties
$mode= '""'
""Details- Type
- n/a
$repositoryUrl= '""'
""Details- Type
- n/a
$svn= 'NULL'
NULLDetails- Type
- n/a
$svnArgs= 'array()'
array()Details- Type
- n/a
$svnPath= '"/usr/bin/svn"'
"/usr/bin/svn"Details- Type
- n/a
$svnSwitches= 'array()'
array()Details- Type
- n/a
$toDir= '""'
""Details- Type
- n/a
$workingCopy= '""'
""Details- Type
- n/a
Methods
getDescription(
)
:
voidgetForce(
)
:
voidReturns the force switch
getIgnoreExternals(
)
:
voidReturns the ignore-externals switch
getLocation(
)
:
voidgetNoCache(
)
:
voidReturns the no-auth-cache switch
getOwningTarget(
)
:
voidgetPassword(
)
:
voidReturns the password
getProject(
)
:
voidgetRecursive(
)
:
voidReturns the non-recursive switch
getRegisterSlot(
)
:
voidgetRepositoryUrl(
)
:
voidReturns the path/URI to the repository
getRuntimeConfigurableWrapper(
)
:
voidgetSvnPath(
)
:
voidReturns the path to the SVN executable
getTaskName(
)
:
voidgetTaskType(
)
:
voidgetToDir(
)
:
voidReturns the path to export/checkout to
getTrustServerCert(
)
:
voidReturns the trust-server-cert switch
getUsername(
)
:
voidReturns the username
getWorkingCopy(
)
:
voidReturns the path to the workingcopy
init(
)
:
voidInitialize Task.
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.
log(
)
:
voidmain(
)
:
voidmaybeConfigure(
)
:
voidperform(
)
:
voidrun(
array $args
=
array(), array $switches
=
array()
)
:
stringExecutes the constructed VersionControl_SVN instance
| Name | Type | Description |
|---|---|---|
| $args | array | Additional arguments to pass to SVN. |
| $switches | array | Switches to pass to SVN. |
| Type | Description |
|---|---|
| string | Output generated by SVN. |
setDescription(
)
:
voidsetForce(
$value
)
:
voidSets the force switch
| Name | Type | Description |
|---|---|---|
| $value |
setIgnoreExternals(
$value
)
:
voidSets the ignore-externals switch
| Name | Type | Description |
|---|---|---|
| $value |
setLocation(
)
:
voidsetNoCache(
$value
)
:
voidSets the no-auth-cache switch
| Name | Type | Description |
|---|---|---|
| $value |
setOwningTarget(
)
:
voidsetPassword(
$value
)
:
voidSets the password of the user to export
| Name | Type | Description |
|---|---|---|
| $value |
setProject(
)
:
voidsetRecursive(
$value
)
:
voidSets the non-recursive switch
| Name | Type | Description |
|---|---|---|
| $value |
setRepositoryUrl(
$repositoryUrl
)
:
voidSets the path/URI to the repository
| Name | Type | Description |
|---|---|---|
| $repositoryUrl |
setRuntimeConfigurableWrapper(
)
:
voidsetSvnPath(
$svnPath
)
:
voidSets the path to the SVN executable
| Name | Type | Description |
|---|---|---|
| $svnPath |
setTaskName(
)
:
voidsetTaskType(
)
:
voidsetToDir(
$toDir
)
:
voidSets the path to export/checkout to
| Name | Type | Description |
|---|---|---|
| $toDir |
setTrustServerCert(
$value
)
:
voidSets the trust-server-cert switch
| Name | Type | Description |
|---|---|---|
| $value |
setUsername(
$value
)
:
voidSets the username of the user to export
| Name | Type | Description |
|---|---|---|
| $value |
setWorkingCopy(
$workingCopy
)
:
voidSets the path to the workingcopy
| Name | Type | Description |
|---|---|---|
| $workingCopy |
setup(
string $mode
)
:
voidCreates a VersionControl_SVN class based on $mode
| Name | Type | Description |
|---|---|---|
| $mode | string | The SVN mode to use (info, export, checkout, ...) |
| Exception | Description |
|---|---|
| \BuildException |