SvnBaseTask

Extends \Task

Base class for Subversion tasks

Use \Project#createTask to register a new Task.

author

Michiel Rook mrook@php.net

author

Andrew Eddie andrew.eddie@jamboworks.com

package

phing.tasks.ext.svn

see
since 2.2.0

Methods

Returns the depth switch

getDepth() 

Returns the textual description of the task

getDescription() : string
inherited

Response

string

The 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. Used by {@link BuildException} to give detailed error messages.

getLocation() : \Location
inherited

Response

\Location

The 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

Response

\Target

The target object that owns this task

Returns the password

getPassword() 

Returns a reference to current project

getProject() : \Project
inherited

Response

\Project

Reference to current porject object

Returns the recursive switch

getRecursive() 
deprecated

Returns a name

getRegisterSlot(string $slotName) : \RegisterSlot
inherited

Arguments

$slotName

string

Response

\RegisterSlot

Returns the path/URI to the repository

getRepositoryUrl() 

Returns the wrapper object for runtime configuration

getRuntimeConfigurableWrapper() : \RuntimeConfigurable
inherited

Response

\RuntimeConfigurable

The 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

Response

string

Name of this task

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

getTaskType() : string
inherited

Response

string

The 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() 

Called by the parser to let the task initialize properly.

init() 
inherited

Should throw a BuildException if something goes wrong with the build

This is abstract here, but may not be overloaded by subclasses.

throws

Logs a message with the given priority.

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

Arguments

$msg

string

The message to be logged.

$level

integer

The message's priority at this message should have

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 <em>phing target1 target2</em> will run all tasks in target3 twice.

main() 
inherited abstract

Should throw a BuildException if someting goes wrong with the build

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

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

maybeConfigure() 
inherited

Perfrom this task

perform() 
inherited
throws

Sets the depth switch

setDepth( $value) 

Arguments

$value

Sets a textual description of the task

setDescription(string $desc) 
inherited

Arguments

$desc

string

The text describing the task

Sets the force switch

setForce( $value) 

Arguments

$value

Sets the ignore-externals switch

setIgnoreExternals( $value) 

Arguments

$value

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

setLocation(\Location $location) 
inherited

Arguments

$location

\Location

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

Sets the no-auth-cache switch

setNoCache( $value) 

Arguments

$value

Sets the owning target this task belongs to.

setOwningTarget(\Target $target) 
inherited

Arguments

$target

\Target

Sets the password of the user to export

setPassword( $value) 

Arguments

$value

References the project to the current component.

setProject(\Project $project) : void
inherited

Arguments

$project

\Project

The reference to the current project

Sets the recursive switch

setRecursive( $value) 
deprecated

Arguments

$value

Sets the path/URI to the repository

setRepositoryUrl( $repositoryUrl) 

Arguments

$repositoryUrl

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

setRuntimeConfigurableWrapper(\RuntimeConfigurable $wrapper) 
inherited

Arguments

$wrapper

\RuntimeConfigurable

The wrapper object this task should use

Sets the path to the SVN executable

setSvnPath( $svnPath) 

Arguments

$svnPath

Sets the name of this task for log messages

setTaskName(string $name) : string
inherited

Arguments

$name

string

Response

string

A string representing the name of this task for log

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

setTaskType( $name) 
inherited

Arguments

$name

Sets the path to export/checkout to

setToDir( $toDir) 

Arguments

$toDir

Sets the trust-server-cert switch

setTrustServerCert( $value) 

Arguments

$value

Creates a VersionControl_SVN class based on $mode

setup( $mode) 
throws

Arguments

$mode

Sets the username of the user to export

setUsername( $value) 

Arguments

$value

Sets the path to the workingcopy

setWorkingCopy( $workingCopy) 

Arguments

$workingCopy

Properties

workingCopy

workingCopy : string
var

Type(s)

string

repositoryUrl

repositoryUrl : string
var

Type(s)

string

svnPath

svnPath : string
var

Type(s)

string

svn

svn : 

Type(s)

mode

mode : 

Type(s)

svnArgs

svnArgs : 

Type(s)

svnSwitches

svnSwitches : 

Type(s)

toDir

toDir : 

Type(s)

fetchMode

fetchMode : 

Type(s)

oldVersion

oldVersion : 

Type(s)

Owning Target object

target : \Target
inherited
var

Type(s)

\Target

Description of the task

description : string
inherited
var

Type(s)

string

Internal taskname (req)

taskType : string
inherited
var

Type(s)

string

Taskname for logger

taskName : string
inherited
var

Type(s)

string

Stored buildfile location

location : \Location
inherited
var

Type(s)

\Location

Wrapper of the task

wrapper : \RuntimeConfigurable
inherited
var

Type(s)

\RuntimeConfigurable

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

project : \Project
inherited
var

A reference to the current project instance

Type(s)

\Project