tasks/ext/svn/SvnBaseTask.php

Show: inherited
Table of Contents

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: b6c644f650a69cad32ced1d030685a7a7a46251c $  

\SvnBaseTask

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
\SvnInfoTask
\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: b6c644f650a69cad32ced1d030685a7a7a46251c $  

Properties

Propertyprotectedstring  $description= ''
inherited

Description of the task

Inherited from: \Task::$$description
Details
Type
string
Inherited_from
\Task::$$description  
Propertyprotected  $fetchMode= 'VERSIONCONTROL_SVN_FETCHMODE_ASSOC'
Default valueVERSIONCONTROL_SVN_FETCHMODE_ASSOCDetails
Type
n/a
Propertyprotected\Location  $location= ''
inherited

Stored buildfile location

Inherited from: \Task::$$location
Details
Type
\Location
Inherited_from
\Task::$$location  
Propertyprivate  $mode= '""'
Default value""Details
Type
n/a
Propertyprotected\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\Task::$$project
Default valuenullDetails
Type
\Project
Inherited_from
\ProjectComponent::$$project  
Inherited_from
\Task::$$project  
Propertyprivate  $repositoryUrl= '""'
Default value""Details
Type
n/a
Propertyprivate  $svn= 'NULL'
Default valueNULLDetails
Type
n/a
Propertyprivate  $svnArgs= 'array()'
Default valuearray()Details
Type
n/a
Propertyprivate  $svnPath= '"/usr/bin/svn"'
Default value"/usr/bin/svn"Details
Type
n/a
Propertyprivate  $svnSwitches= 'array()'
Default valuearray()Details
Type
n/a
Propertyprotected\Target  $target= ''
inherited

Owning Target object

Inherited from: \Task::$$target
Details
Type
\Target
Inherited_from
\Task::$$target  
Propertyprotectedstring  $taskName= ''
inherited

Taskname for logger

Inherited from: \Task::$$taskName
Details
Type
string
Inherited_from
\Task::$$taskName  
Propertyprotectedstring  $taskType= ''
inherited

Internal taskname (req)

Inherited from: \Task::$$taskType
Details
Type
string
Inherited_from
\Task::$$taskType  
Propertyprivate  $toDir= '""'
Default value""Details
Type
n/a
Propertyprivate  $workingCopy= '""'
Default value""Details
Type
n/a
Propertyprotected\RuntimeConfigurable  $wrapper= ''
inherited

Wrapper of the task

Inherited from: \Task::$$wrapper
Details
Type
\RuntimeConfigurable
Inherited_from
\Task::$$wrapper  

Methods

methodpublicgetDescription( ) : string
inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()
Returns
Type Description
string The text description of the task
methodpublicgetForce( ) : void

Returns the force switch

methodpublicgetIgnoreExternals( ) : void

Returns the ignore-externals switch

methodpublicgetLocation( ) : \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.
methodpublicgetNoCache( ) : void

Returns the no-auth-cache switch

methodpublicgetOwningTarget( ) : \Target
inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()
Returns
Type Description
\Target The target object that owns this task
methodpublicgetPassword( ) : void

Returns the password

methodpublicgetProject( ) : \Project
inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()\Task::getProject()
Returns
Type Description
\Project Reference to current porject object
methodpublicgetRecursive( ) : void

Returns the non-recursive switch

methodprotectedgetRegisterSlot( string $slotName ) : void
inherited

Returns a name

Inherited from: \Task::getRegisterSlot()
Parameters
Name Type Description
$slotName string
methodpublicgetRepositoryUrl( ) : void

Returns the path/URI to the repository

methodpublicgetRuntimeConfigurableWrapper( ) : \RuntimeConfigurable
inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()
Returns
Type Description
\RuntimeConfigurable The wrapper object used by this task
methodpublicgetSvnPath( ) : void

Returns the path to the SVN executable

methodpublicgetTaskName( ) : string
inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()
Returns
Type Description
string Name of this task
methodpublicgetTaskType( ) : 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)
methodpublicgetToDir( ) : void

Returns the path to export/checkout to

methodpublicgetTrustServerCert( ) : void

Returns the trust-server-cert switch

methodpublicgetUsername( ) : void

Returns the username

methodpublicgetWorkingCopy( ) : void

Returns the path to the workingcopy

methodpublicinit( ) : 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
methodpubliclog( string $msg, integer $level = Project::MSG_INFO ) : void
inherited

Provides a project level log event to the task.

Inherited from: \Task::log()
Parameters
Name Type Description
$msg string

The message to log

$level integer

The priority of the message

Details
See
\BuildEvent  
See
\BuildListener  
methodpublicmain( ) : void
abstractinherited

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.

methodpublicmaybeConfigure( ) : void
inherited

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

Inherited from: \Task::maybeConfigure()
methodpublicperform( ) : void
inherited

Perfrom this task

Inherited from: \Task::perform()
methodprotectedrun( 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.
methodpublicsetDescription( 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

methodpublicsetForce(  $value ) : void

Sets the force switch

Parameters
Name Type Description
$value
methodpublicsetIgnoreExternals(  $value ) : void

Sets the ignore-externals switch

Parameters
Name Type Description
$value
methodpublicsetLocation( \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.

methodpublicsetNoCache(  $value ) : void

Sets the no-auth-cache switch

Parameters
Name Type Description
$value
methodpublicsetOwningTarget( \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

methodpublicsetPassword(  $value ) : void

Sets the password of the user to export

Parameters
Name Type Description
$value
methodpublicsetProject( \Project $project ) : void
inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()\Task::setProject()
Parameters
Name Type Description
$project \Project

The reference to the current project

methodpublicsetRecursive(  $value ) : void

Sets the non-recursive switch

Parameters
Name Type Description
$value
methodpublicsetRepositoryUrl(  $repositoryUrl ) : void

Sets the path/URI to the repository

Parameters
Name Type Description
$repositoryUrl
methodpublicsetRuntimeConfigurableWrapper( \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

methodpublicsetSvnPath(  $svnPath ) : void

Sets the path to the SVN executable

Parameters
Name Type Description
$svnPath
methodpublicsetTaskName( string $name ) : string
inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()
Parameters
Name Type Description
$name string
Returns
Type Description
string A string representing the name of this task for log
methodpublicsetTaskType( 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)

methodpublicsetToDir(  $toDir ) : void

Sets the path to export/checkout to

Parameters
Name Type Description
$toDir
methodpublicsetTrustServerCert(  $value ) : void

Sets the trust-server-cert switch

Parameters
Name Type Description
$value
methodpublicsetUsername(  $value ) : void

Sets the username of the user to export

Parameters
Name Type Description
$value
methodpublicsetWorkingCopy(  $workingCopy ) : void

Sets the path to the workingcopy

Parameters
Name Type Description
$workingCopy
methodprotectedsetup( 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.18.1.