Base class for Subversion tasks

Use Project#createTask to register a new Task.

author Michiel Rook
author Andrew Eddie
version $Id: c8aac38c214e9c6d2c4ea140fcc63808140fd386 $
package phing.tasks.ext.svn
see \global\VersionControl_SVN
since 2.2.0
copyright 2001,2002 THYRELL. All rights reserved

 Methods

Returns the textual description of the task

getDescription() : string
Inherited
inherited_from \Task::getDescription()

Returns

stringThe text description of the task

Returns the force switch

getForce() 

Returns the ignore-externals switch

getIgnoreExternals() 

Returns the location within the buildfile this task occurs.

getLocation() : \Location
Inherited

Used by BuildException to give detailed error messages.

inherited_from \Task::getLocation()

Returns

\LocationThe location object describing the position of this task within the buildfile.

Returns the no-auth-cache switch

getNoCache() 

Returns the owning target of this task.

getOwningTarget() : \Target
Inherited
inherited_from \Task::getOwningTarget()

Returns

\TargetThe target object that owns this task

Returns the password

getPassword() 

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 non-recursive switch

getRecursive() 

Returns the path/URI to the repository

getRepositoryUrl() 

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
Inherited
inherited_from \Task::getRuntimeConfigurableWrapper()

Returns

\RuntimeConfigurableThe wrapper object used by this task

Returns the path to the SVN executable

getSvnPath() 

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)

Returns the path to export/checkout to

getToDir() 

Returns the trust-server-cert switch

getTrustServerCert() 

Returns the username

getUsername() 

Returns the path to the workingcopy

getWorkingCopy() 

Initialize Task.

init() 

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.

Exceptions

\BuildException

Provides a project level log event to the task.

log(string $msg, integer $level) 
Inherited
see \global\BuildEvent
see \global\BuildListener
inherited_from \Task::log()

Parameters

$msg

string

The message to log

$level

integer

The priority of the message

Called by the project to let the task do it's work.

main() 
Inherited

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.

inherited_from \Task::main()

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

maybeConfigure() 
Inherited
inherited_from \Task::maybeConfigure()

Perfrom this task

perform() 
Inherited
inherited_from \Task::perform()

Sets a textual description of the task

setDescription(string $desc) 
Inherited
inherited_from \Task::setDescription()

Parameters

$desc

string

The text describing the task

Sets the force switch

setForce($value) 

Parameters

$value

Sets the ignore-externals switch

setIgnoreExternals($value) 

Parameters

$value

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

\Location

The location object describing the position of this task within the buildfile.

Sets the no-auth-cache switch

setNoCache($value) 

Parameters

$value

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
Inherited
inherited_from \Task::setOwningTarget()

Parameters

$target

\Target

Reference to owning target

Sets the password of the user to export

setPassword($value) 

Parameters

$value

References the project to the current component.

setProject(\Project $project) 
Inherited
inherited_from \ProjectComponent::setProject()
inherited_from \Task::setProject()

Parameters

$project

\Project

The reference to the current project

Sets the non-recursive switch

setRecursive($value) 

Parameters

$value

Sets the path/URI to the repository

setRepositoryUrl($repositoryUrl) 

Parameters

$repositoryUrl

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
Inherited
inherited_from \Task::setRuntimeConfigurableWrapper()

Parameters

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the path to the SVN executable

setSvnPath($svnPath) 

Parameters

$svnPath

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

string

The type of this task (XML Tag)

Sets the path to export/checkout to

setToDir($toDir) 

Parameters

$toDir

Sets the trust-server-cert switch

setTrustServerCert($value) 

Parameters

$value

Sets the username of the user to export

setUsername($value) 

Parameters

$value

Sets the path to the workingcopy

setWorkingCopy($workingCopy) 

Parameters

$workingCopy

Returns a name

getRegisterSlot(string $slotName) 
Inherited
inherited_from \Task::getRegisterSlot()

Parameters

$slotName

string

Executes the constructed VersionControl_SVN instance

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

Parameters

$args

array

Additional arguments to pass to SVN.

$switches

array

Switches to pass to SVN.

Returns

stringOutput generated by SVN.

Creates a VersionControl_SVN class based on $mode

setup(string $mode) 

Parameters

$mode

string

The SVN mode to use (info, export, checkout, ...)

Exceptions

\BuildException

 Properties

 

$description : string
Inherited
inherited_from \Task::$$description
 

$fetchMode 
 

$location : \Location
Inherited
inherited_from \Task::$$location
 

$oldVersion 
 

$project : \Project
Inherited
inherited_from \ProjectComponent::$$project
inherited_from \Task::$$project
 

$svn 
 

$target : \Target
Inherited
inherited_from \Task::$$target
 

$taskName : string
Inherited
inherited_from \Task::$$taskName
 

$taskType : string
Inherited
inherited_from \Task::$$taskType
 

$wrapper : \RuntimeConfigurable
Inherited
inherited_from \Task::$$wrapper
 

$mode 
 

$repositoryUrl 
 

$svnArgs 
 

$svnPath 
 

$svnSwitches 
 

$toDir 
 

$workingCopy