tasks/ext/svn/SvnExportTask.php

Show:

inherited

Classes
- \SvnExportTask

Table of Contents

$Id: SvnExportTask.php 1307 2011-10-06 20:53:32Z 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.

\SvnExportTask
jump to top

Package: phing\tasks\ext\svn

Exports/checks out a repository to a local directory with authentication

Parent(s): \SvnBaseTask < \Task < \ProjectComponent
Author: Michiel Rook
Author: Andrew Eddie
Since: 2.2.0
Version: $Id: SvnExportTask.php 1307 2011-10-06 20:53:32Z mrook $

Properties


                 $mode= '""'

inheritedInherited from: \SvnBaseTask::$$mode

Default value""Details

Type: n/a
Inherited_from: \SvnBaseTask::$$mode


                 $repositoryUrl= '""'

inheritedInherited from: \SvnBaseTask::$$repositoryUrl

Default value""Details

Type: n/a
Inherited_from: \SvnBaseTask::$$repositoryUrl

string
                 $revision= ''HEAD''

Which Revision to Export

Default value'HEAD'Details

Type: string
Todo: check if version_control_svn supports constants


                 $svn= 'NULL'

inheritedInherited from: \SvnBaseTask::$$svn

Default valueNULLDetails

Type: n/a
Inherited_from: \SvnBaseTask::$$svn


                 $svnArgs= 'array()'

inheritedInherited from: \SvnBaseTask::$$svnArgs

Default valuearray()Details

Type: n/a
Inherited_from: \SvnBaseTask::$$svnArgs


                 $svnPath= '"/usr/bin/svn"'

inheritedInherited from: \SvnBaseTask::$$svnPath

Default value"/usr/bin/svn"Details

Type: n/a
Inherited_from: \SvnBaseTask::$$svnPath


                 $svnSwitches= 'array()'

inheritedInherited from: \SvnBaseTask::$$svnSwitches

Default valuearray()Details

Type: n/a
Inherited_from: \SvnBaseTask::$$svnSwitches


                 $toDir= '""'

inheritedInherited from: \SvnBaseTask::$$toDir

Default value""Details

Type: n/a
Inherited_from: \SvnBaseTask::$$toDir


                 $workingCopy= '""'

inheritedInherited from: \SvnBaseTask::$$workingCopy

Default value""Details

Type: n/a
Inherited_from: \SvnBaseTask::$$workingCopy

Methods

getDescription(
          
          )
        
        :
          void

inherited

Inherited from: Task::getDescription()\SvnBaseTask::getDescription()

getForce(
          
          )
        
        :
          void

inherited

Returns the force switch

Inherited from: \SvnBaseTask::getForce()

getIgnoreExternals(
          
          )
        
        :
          void

inherited

Returns the ignore-externals switch

Inherited from: \SvnBaseTask::getIgnoreExternals()

getLocation(
          
          )
        
        :
          void

inherited

Inherited from: Task::getLocation()\SvnBaseTask::getLocation()

getNoCache(
          
          )
        
        :
          void

inherited

Returns the no-auth-cache switch

Inherited from: \SvnBaseTask::getNoCache()

getOwningTarget(
          
          )
        
        :
          void

inherited

Inherited from: Task::getOwningTarget()\SvnBaseTask::getOwningTarget()

getPassword(
          
          )
        
        :
          void

inherited

Returns the password

Inherited from: \SvnBaseTask::getPassword()

getProject(
          
          )
        
        :
          void

inherited

Inherited from: ProjectComponent::getProject()\SvnBaseTask::getProject()

getRecursive(
          
          )
        
        :
          void

inherited

Returns the non-recursive switch

Inherited from: \SvnBaseTask::getRecursive()

getRegisterSlot(
          
          )
        
        :
          void

inherited

Inherited from: Task::getRegisterSlot()\SvnBaseTask::getRegisterSlot()

getRepositoryUrl(
          
          )
        
        :
          void

inherited

Returns the path/URI to the repository

Inherited from: \SvnBaseTask::getRepositoryUrl()

getRuntimeConfigurableWrapper(
          
          )
        
        :
          void

inherited

Inherited from: Task::getRuntimeConfigurableWrapper()\SvnBaseTask::getRuntimeConfigurableWrapper()

getSvnPath(
          
          )
        
        :
          void

inherited

Returns the path to the SVN executable

Inherited from: \SvnBaseTask::getSvnPath()

getTaskName(
          
          )
        
        :
          void

inherited

Inherited from: Task::getTaskName()\SvnBaseTask::getTaskName()

getTaskType(
          
          )
        
        :
          void

inherited

Inherited from: Task::getTaskType()\SvnBaseTask::getTaskType()

getToDir(
          
          )
        
        :
          void

inherited

Returns the path to export/checkout to

Inherited from: \SvnBaseTask::getToDir()

getTrustServerCert(
          
          )
        
        :
          void

inherited

Returns the trust-server-cert switch

Inherited from: \SvnBaseTask::getTrustServerCert()

getUsername(
          
          )
        
        :
          void

inherited

Returns the username

Inherited from: \SvnBaseTask::getUsername()

getWorkingCopy(
          
          )
        
        :
          void

inherited

Returns the path to the workingcopy

Inherited from: \SvnBaseTask::getWorkingCopy()

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.

inherited

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

The main entry point

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

inherited

Inherited from: Task::maybeConfigure()\SvnBaseTask::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Inherited from: Task::perform()\SvnBaseTask::perform()

run(
          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.

setDescription(
          
          )
        
        :
          void

inherited

Inherited from: Task::setDescription()\SvnBaseTask::setDescription()

setForce(
           $value
          )
        
        :
          void

inherited

Sets the force switch

Inherited from: \SvnBaseTask::setForce()

Parameters

Name	Type	Description
$value

setIgnoreExternals(
           $value
          )
        
        :
          void

inherited

Sets the ignore-externals switch

Inherited from: \SvnBaseTask::setIgnoreExternals()

Parameters

Name	Type	Description
$value

setLocation(
          
          )
        
        :
          void

inherited

Inherited from: Task::setLocation()\SvnBaseTask::setLocation()

setNoCache(
           $value
          )
        
        :
          void

inherited

Sets the no-auth-cache switch

Inherited from: \SvnBaseTask::setNoCache()

Parameters

Name	Type	Description
$value

setOwningTarget(
          
          )
        
        :
          void

inherited

Inherited from: Task::setOwningTarget()\SvnBaseTask::setOwningTarget()

setPassword(
           $value
          )
        
        :
          void

inherited

Sets the password of the user to export

Inherited from: \SvnBaseTask::setPassword()

Parameters

Name	Type	Description
$value

setProject(
          
          )
        
        :
          void

inherited

Inherited from: ProjectComponent::setProject()\SvnBaseTask::setProject()

setRecursive(
           $value
          )
        
        :
          void

inherited

Sets the non-recursive switch

Inherited from: \SvnBaseTask::setRecursive()

Parameters

Name	Type	Description
$value

setRepositoryUrl(
           $repositoryUrl
          )
        
        :
          void

inherited

Sets the path/URI to the repository

Inherited from: \SvnBaseTask::setRepositoryUrl()

Parameters

Name	Type	Description
$repositoryUrl

setRevision(
           $revision
          )
        
        :
          void

Parameters

Name	Type	Description
$revision

setRuntimeConfigurableWrapper(
          
          )
        
        :
          void

inherited

Inherited from: Task::setRuntimeConfigurableWrapper()\SvnBaseTask::setRuntimeConfigurableWrapper()

setSvnPath(
           $svnPath
          )
        
        :
          void

inherited

Sets the path to the SVN executable

Inherited from: \SvnBaseTask::setSvnPath()

Parameters

Name	Type	Description
$svnPath

setTaskName(
          
          )
        
        :
          void

inherited

Inherited from: Task::setTaskName()\SvnBaseTask::setTaskName()

setTaskType(
          
          )
        
        :
          void

inherited

Inherited from: Task::setTaskType()\SvnBaseTask::setTaskType()

setToDir(
           $toDir
          )
        
        :
          void

inherited

Sets the path to export/checkout to

Inherited from: \SvnBaseTask::setToDir()

Parameters

Name	Type	Description
$toDir

setTrustServerCert(
           $value
          )
        
        :
          void

inherited

Sets the trust-server-cert switch

Inherited from: \SvnBaseTask::setTrustServerCert()

Parameters

Name	Type	Description
$value

setUsername(
           $value
          )
        
        :
          void

inherited

Sets the username of the user to export

Inherited from: \SvnBaseTask::setUsername()

Parameters

Name	Type	Description
$value

setWorkingCopy(
           $workingCopy
          )
        
        :
          void

inherited

Sets the path to the workingcopy

Inherited from: \SvnBaseTask::setWorkingCopy()

Parameters

Name	Type	Description
$workingCopy

setup(
          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

tasks/ext/svn/SvnExportTask.php

\SvnExportTaskjump to top

Properties

Methods

\SvnExportTask
jump to top