# tasks/ext/svn/SvnBaseTask.php

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
jump to top

Package: phing\tasks\ext\svn

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= '""'`
Default value`""`Details

Type
  n/a

`$repositoryUrl= '""'`
Default value`""`Details

Type
  n/a

`$svn= 'NULL'`
Default value `NULL` Details

Type
  n/a

`$svnArgs= 'array()'`
Default value `array()`Details

Type
  n/a

`$svnPath= '"/usr/bin/svn"'`
Default value`"/usr/bin/svn"`Details

Type
  n/a

`$svnSwitches= 'array()'`
Default value `array()`Details

Type
  n/a

`$toDir= '""'`
Default value`""`Details

Type
  n/a

`$workingCopy= '""'`
Default value`""`Details

Type
  n/a

### Methods

`getDescription( ) : void`

`getForce( ) : void`

Returns the force switch

`getIgnoreExternals( ) : void`

Returns the ignore-externals switch

`getLocation( ) : void`

`getNoCache( ) : void`

Returns the no-auth-cache switch

`getOwningTarget( ) : void`

`getPassword( ) : void`

Returns the password

`getProject( ) : void`

`getRecursive( ) : void`

Returns the non-recursive switch

`getRegisterSlot( ) : void`

`getRepositoryUrl( ) : void`

Returns the path/URI to the repository

`getRuntimeConfigurableWrapper( ) : void`

`getSvnPath( ) : void`

Returns the path to the SVN executable

`getTaskName( ) : void`

`getTaskType( ) : void`

`getToDir( ) : void`

Returns the path to export/checkout to

`getTrustServerCert( ) : void`

Returns the trust-server-cert switch

`getUsername( ) : void`

Returns the username

`getWorkingCopy( ) : void`

Returns the path to the workingcopy

`init( ) : void`

Initialize 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( ) : void`

`main( ) : void`
abstract

`maybeConfigure( ) : void`

`perform( ) : void`

`run( array $args = array(), array $switches = array() ) : string`

Executes the constructed VersionControl_SVN instance

Parameters

Name | Type | Description
--- | --- | ---
$args | array | Additional arguments to pass to SVN.
$switches | array | Switches to pass to SVN.

Returns

Type | Description
--- | ---
string | Output generated by SVN.

`setDescription( ) : void`

`setForce( $value ) : void`

Sets the force switch

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setIgnoreExternals( $value ) : void`

Sets the ignore-externals switch

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setLocation( ) : void`

`setNoCache( $value ) : void`

Sets the no-auth-cache switch

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setOwningTarget( ) : void`

`setPassword( $value ) : void`

Sets the password of the user to export

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setProject( ) : void`

`setRecursive( $value ) : void`

Sets the non-recursive switch

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setRepositoryUrl( $repositoryUrl ) : void`

Sets the path/URI to the repository

Parameters

Name | Type | Description
--- | --- | ---
$repositoryUrl |  |

`setRuntimeConfigurableWrapper( ) : void`

`setSvnPath( $svnPath ) : void`

Sets the path to the SVN executable

Parameters

Name | Type | Description
--- | --- | ---
$svnPath |  |

`setTaskName( ) : void`

`setTaskType( ) : void`

`setToDir( $toDir ) : void`

Sets the path to export/checkout to

Parameters

Name | Type | Description
--- | --- | ---
$toDir |  |

`setTrustServerCert( $value ) : void`

Sets the trust-server-cert switch

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setUsername( $value ) : void`

Sets the username of the user to export

Parameters

Name | Type | Description
--- | --- | ---
$value |  |

`setWorkingCopy( $workingCopy ) : void`

Sets the path to the workingcopy

Parameters

Name | Type | Description
--- | --- | ---
$workingCopy |  |

`setup( string $mode ) : void`

Creates a VersionControl_SVN class based on $mode

Parameters

Name | Type | Description
--- | --- | ---
$mode | string | The SVN mode to use (info, export, checkout, ...)

Throws

Exception | Description
--- | ---
\BuildException |

Documentation was generated by DocBlox 0.17.1.