# 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 808 2010-08-12 18:44:39Z mrook $

## \SvnBaseTask
jump to top

Package: phing\tasks\ext\svn

Base class for Subversion tasks

Use {@link Project#createTask} to register a new Task.

Parent(s)
  \Task < \ProjectComponent
Children
  \SvnCopyTask
  \SvnLogTask
  \SvnSwitchTask
  \SvnCheckoutTask
  \SvnListTask
  \SvnCommitTask
  \SvnExportTask
  \SvnUpdateTask
  \SvnLastRevisionTask
See
  \VersionControl_SVN
Author
  Michiel Rook
Author
  Andrew Eddie
Copyright
  2001,2002 THYRELL. All rights reserved
Since
  2.2.0
Version
  $Id: SvnBaseTask.php 808 2010-08-12 18:44:39Z mrook $

### Properties

`string $description= ''`
inherited

description of the taskInherited from: \Task::$description
Details

Type
  string
Inherited_from
  \Task::$description

`\Location $location= ''`
inherited

stored buildfile locationInherited from: \Task::$location
Details

Type
  \Location
Inherited_from
  \Task::$location

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

Type

`\Project $project= 'null'`
inherited

Holds a reference to the project that a project component (a task, a target, etc.) belongs to

A reference to the current project instanceInherited from: \ProjectComponent::$project
Default value `null` Details

Type
  \Project
Inherited_from
  \ProjectComponent::$project

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

Type

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

Type

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

Type

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

Type

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

Type

`\Target $target= ''`
inherited

owning Target objectInherited from: \Task::$target
Details

Type
  \Target
Inherited_from
  \Task::$target

`string $taskName= ''`
inherited

Taskname for loggerInherited from: \Task::$taskName
Details

Type
  string
Inherited_from
  \Task::$taskName

`string $taskType= ''`
inherited

internal taskname (req)Inherited from: \Task::$taskType
Details

Type
  string
Inherited_from
  \Task::$taskType

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

Type

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

Type

`\RuntimeConfigurable $wrapper= ''`
inherited

wrapper of the taskInherited from: \Task::$wrapper
Details

Type
  \RuntimeConfigurable
Inherited_from
  \Task::$wrapper

### Methods

`getDescription( ) : string`
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns

Type | Description
--- | ---
string | The text description of the task

`getForce( ) : void`

Returns the force switch

`getIgnoreExternals( ) : void`

Returns the ignore-externals switch

`getLocation( ) : \Location`
inherited

Returns the location within the buildfile this task occurs. Used by {@link BuildException} to give detailed error messages.

Inherited from: \Task::getLocation()
Returns

Type | Description
--- | ---
\Location | The location object describing the position of this task within the buildfile.

`getNoCache( ) : void`

Returns the no-auth-cache switch

`getOwningTarget( ) : \Target`
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns

Type | Description
--- | ---
\Target | The target object that owns this task

`getPassword( ) : void`

Returns the password

`getProject( ) : \Project`
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()
Returns

Type | Description
--- | ---
\Project | Reference to current porject object

`getRecursive( ) : void`

Returns the non-recursive switch

`getRegisterSlot( $slotName ) : void`
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters

Name | Type | Description
--- | --- | ---
$slotName |  |

`getRepositoryUrl( ) : void`

Returns the path/URI to the repository

`getRuntimeConfigurableWrapper( ) : \RuntimeConfigurable`
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns

Type | Description
--- | ---
\RuntimeConfigurable | The wrapper object used by this task

`getSvnPath( ) : void`

Returns the path to the SVN executable

`getTaskName( ) : string`
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns

Type | Description
--- | ---
string | Name of this task

`getTaskType( ) : string`
inherited

Returns the name of the task under which it was invoked, usually the XML tagname

Inherited from: \Task::getTaskType()
Returns

Type | Description
--- | ---
string | The type of this task (XML Tag)

`getToDir( ) : void`

Returns the path to export/checkout to

`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.

Throws

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

`log( string $msg, integer $level = Project::MSG_INFO ) : void`
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name | Type | Description
--- | --- | ---
$msg | string | The message to log
$level | integer | The priority of the message

Details

See
  \BuildEvent
See
  \BuildListener

`main( ) : void`
abstract inherited

Called by the project to let the task do it's work. 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.

Inherited from: \Task::main()

Should throw a BuildException if someting goes wrong with the build

This is abstract here. Must be overloaded by real tasks.

`maybeConfigure( ) : void`
inherited

Configure this task if it hasn't been done already.

Inherited from: \Task::maybeConfigure()
`perform( ) : void`
inherited

Perfrom this task

Inherited from: \Task::perform()
`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( string $desc ) : void`
inherited

Sets a textual description of the task

Inherited from: \Task::setDescription()
Parameters

Name | Type | Description
--- | --- | ---
$desc | string | The text describing the task

`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( \Location $location ) : void`
inherited

Sets the location within the buildfile this task occurs. Called by the parser to set location information.

Inherited from: \Task::setLocation()
Parameters

Name | Type | Description
--- | --- | ---
$location | \Location | The location object describing the position of this task within the buildfile.

`setNoCache( $value ) : void`

Sets the no-auth-cache switch

Parameters

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

`setOwningTarget( \Target $target ) : void`
inherited

Sets the owning target this task belongs to.

Inherited from: \Task::setOwningTarget()
Parameters

Name | Type | Description
--- | --- | ---
$target | \Target | Reference to owning target

`setPassword( $value ) : void`

Sets the password of the user to export

Parameters

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

`setProject( \Project $project ) : void`
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()
Parameters

Name | Type | Description
--- | --- | ---
$project | \Project | The reference to the current project

`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( \RuntimeConfigurable $wrapper ) : void`
inherited

Sets the wrapper object this task should use for runtime configurable elements.

Inherited from: \Task::setRuntimeConfigurableWrapper()
Parameters

Name | Type | Description
--- | --- | ---
$wrapper | \RuntimeConfigurable | The wrapper object this task should use

`setSvnPath( $svnPath ) : void`

Sets the path to the SVN executable

Parameters

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

`setTaskName( $name ) : string`
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters

Name | Type | Description
--- | --- | ---
$name |  |

Returns

Type | Description
--- | ---
string | A string representing the name of this task for log

`setTaskType( string $name ) : void`
inherited

Sets the type of the task. Usually this is the name of the XML tag

Inherited from: \Task::setTaskType()
Parameters

Name | Type | Description
--- | --- | ---
$name | string | The type of this task (XML Tag)

`setToDir( $toDir ) : void`

Sets the path to export/checkout to

Parameters

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

`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.15.1.