tasks/ext/svn/SvnUpdateTask.php

Show: inherited
Table of Contents

$Id: SvnUpdateTask.php 552 2009-08-29 12:18:13Z mrook $

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals and is licensed under the LGPL. For more information please see http://phing.info.

\SvnUpdateTask

Package: phing\tasks\ext\svn

Updates a repository in local directory

Parent(s)
\SvnBaseTask < \Task < \ProjectComponent
Author
Andrew Eddie  
Since
2.3.0  
Version
$Id: SvnUpdateTask.php 552 2009-08-29 12:18:13Z mrook $  

Properties

Propertyprivate  $mode= '""'
inheritedInherited from: \SvnBaseTask::$$mode
Default value""Details
Type
n/a
Inherited_from
\SvnBaseTask::$$mode  
Propertyprivate  $repositoryUrl= '""'
inheritedInherited from: \SvnBaseTask::$$repositoryUrl
Default value""Details
Type
n/a
Inherited_from
\SvnBaseTask::$$repositoryUrl  
Propertyprivatestring  $revision= ''HEAD''

Which Revision to Export

Default value'HEAD'Details
Type
string
Todo
check if version_control_svn supports constants  
Propertyprivate  $svn= 'NULL'
inheritedInherited from: \SvnBaseTask::$$svn
Default valueNULLDetails
Type
n/a
Inherited_from
\SvnBaseTask::$$svn  
Propertyprivate  $svnArgs= 'array()'
inheritedInherited from: \SvnBaseTask::$$svnArgs
Default valuearray()Details
Type
n/a
Inherited_from
\SvnBaseTask::$$svnArgs  
Propertyprivate  $svnPath= '"/usr/bin/svn"'
inheritedInherited from: \SvnBaseTask::$$svnPath
Default value"/usr/bin/svn"Details
Type
n/a
Inherited_from
\SvnBaseTask::$$svnPath  
Propertyprivate  $svnSwitches= 'array()'
inheritedInherited from: \SvnBaseTask::$$svnSwitches
Default valuearray()Details
Type
n/a
Inherited_from
\SvnBaseTask::$$svnSwitches  
Propertyprivate  $toDir= '""'
inheritedInherited from: \SvnBaseTask::$$toDir
Default value""Details
Type
n/a
Inherited_from
\SvnBaseTask::$$toDir  
Propertyprivate  $workingCopy= '""'
inheritedInherited from: \SvnBaseTask::$$workingCopy
Default value""Details
Type
n/a
Inherited_from
\SvnBaseTask::$$workingCopy  

Methods

methodpublicgetDescription( ) : void
methodpublicgetForce( ) : void
inherited

Returns the force switch

Inherited from: \SvnBaseTask::getForce()
methodpublicgetIgnoreExternals( ) : void
inherited

Returns the ignore-externals switch

Inherited from: \SvnBaseTask::getIgnoreExternals()
methodpublicgetLocation( ) : void
methodpublicgetNoCache( ) : void
inherited

Returns the no-auth-cache switch

Inherited from: \SvnBaseTask::getNoCache()
methodpublicgetOwningTarget( ) : void
methodpublicgetPassword( ) : void
inherited

Returns the password

Inherited from: \SvnBaseTask::getPassword()
methodpublicgetProject( ) : void
methodpublicgetRecursive( ) : void
inherited

Returns the non-recursive switch

Inherited from: \SvnBaseTask::getRecursive()
methodprotectedgetRegisterSlot( ) : void
methodpublicgetRepositoryUrl( ) : void
inherited

Returns the path/URI to the repository

Inherited from: \SvnBaseTask::getRepositoryUrl()
methodpublicgetRuntimeConfigurableWrapper( ) : void
methodpublicgetSvnPath( ) : void
inherited

Returns the path to the SVN executable

Inherited from: \SvnBaseTask::getSvnPath()
methodpublicgetTaskName( ) : void
methodpublicgetTaskType( ) : void
methodpublicgetToDir( ) : void
inherited

Returns the path to export/checkout to

Inherited from: \SvnBaseTask::getToDir()
methodpublicgetTrustServerCert( ) : void
inherited

Returns the trust-server-cert switch

Inherited from: \SvnBaseTask::getTrustServerCert()
methodpublicgetUsername( ) : void
inherited

Returns the username

Inherited from: \SvnBaseTask::getUsername()
methodpublicgetWorkingCopy( ) : void
inherited

Returns the path to the workingcopy

Inherited from: \SvnBaseTask::getWorkingCopy()
methodpublicinit( ) : void
inherited

Initialize Task.

Inherited from: \SvnBaseTask::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.

methodpubliclog( ) : void
inherited

Inherited from: Task::log()\SvnBaseTask::log()
methodpublicmain( ) : void

The main entry point

Throws
Exception Description
\BuildException
methodpublicmaybeConfigure( ) : void
methodpublicperform( ) : void
inherited

Inherited from: Task::perform()\SvnBaseTask::perform()
methodprotectedrun( array $args = array(), array $switches = array() ) : string
inherited

Executes the constructed VersionControl_SVN instance

Inherited from: \SvnBaseTask::run()
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( ) : void
methodpublicsetForce(  $value ) : void
inherited

Sets the force switch

Inherited from: \SvnBaseTask::setForce()
Parameters
Name Type Description
$value
methodpublicsetIgnoreExternals(  $value ) : void
inherited

Sets the ignore-externals switch

Inherited from: \SvnBaseTask::setIgnoreExternals()
Parameters
Name Type Description
$value
methodpublicsetLocation( ) : void
methodpublicsetNoCache(  $value ) : void
inherited

Sets the no-auth-cache switch

Inherited from: \SvnBaseTask::setNoCache()
Parameters
Name Type Description
$value
methodpublicsetOwningTarget( ) : void
methodpublicsetPassword(  $value ) : void
inherited

Sets the password of the user to export

Inherited from: \SvnBaseTask::setPassword()
Parameters
Name Type Description
$value
methodpublicsetProject( ) : void
methodpublicsetRecursive(  $value ) : void
inherited

Sets the non-recursive switch

Inherited from: \SvnBaseTask::setRecursive()
Parameters
Name Type Description
$value
methodpublicsetRepositoryUrl(  $repositoryUrl ) : void
inherited

Sets the path/URI to the repository

Inherited from: \SvnBaseTask::setRepositoryUrl()
Parameters
Name Type Description
$repositoryUrl
methodpublicsetRevision(  $revision ) : void

Parameters
Name Type Description
$revision
methodpublicsetRuntimeConfigurableWrapper( ) : void
methodpublicsetSvnPath(  $svnPath ) : void
inherited

Sets the path to the SVN executable

Inherited from: \SvnBaseTask::setSvnPath()
Parameters
Name Type Description
$svnPath
methodpublicsetTaskName( ) : void
methodpublicsetTaskType( ) : void
methodpublicsetToDir(  $toDir ) : void
inherited

Sets the path to export/checkout to

Inherited from: \SvnBaseTask::setToDir()
Parameters
Name Type Description
$toDir
methodpublicsetTrustServerCert(  $value ) : void
inherited

Sets the trust-server-cert switch

Inherited from: \SvnBaseTask::setTrustServerCert()
Parameters
Name Type Description
$value
methodpublicsetUsername(  $value ) : void
inherited

Sets the username of the user to export

Inherited from: \SvnBaseTask::setUsername()
Parameters
Name Type Description
$value
methodpublicsetWorkingCopy(  $workingCopy ) : void
inherited

Sets the path to the workingcopy

Inherited from: \SvnBaseTask::setWorkingCopy()
Parameters
Name Type Description
$workingCopy
methodprotectedsetup( string $mode ) : void
inherited

Creates a VersionControl_SVN class based on $mode

Inherited from: \SvnBaseTask::setup()
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.