tasks/ext/svn/SvnSwitchTask.php

Show:

inherited

Classes
- \SvnSwitchTask

Table of Contents

$Id: SvnSwitchTask.php 889 2010-09-27 05:46:46Z victor $

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.

\SvnSwitchTask
jump to top

Package: phing\tasks\ext\svn

Switches a repository at a given local directory to a different location

Use {@link Project#createTask} to register a new Task.

Parent(s): \SvnBaseTask < \Task < \ProjectComponent
Author: Dom Udall
Copyright: 2001,2002 THYRELL. All rights reserved
Since: 2.4.3
Version: $Id: SvnSwitchTask.php 889 2010-09-27 05:46:46Z victor $

Properties

string
                 $description= ''

inherited

description of the taskInherited from: \Task::$description

Details

Type: string
Inherited_from: \Task::$description

\Location
                 $location= ''

inherited

stored buildfile locationInherited from: \Task::$location

Details

Type: \Location
Inherited_from: \Task::$location

\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

Default valuenullDetails

Type: \Project
Inherited_from: \ProjectComponent::$project

string
                 $revision= ''HEAD''

Which Revision to Export

Default value'HEAD'Details

Type: string
Todo: check if version_control_svn supports constants

\Target
                 $target= ''

inherited

owning Target objectInherited from: \Task::$target

Details

Type: \Target
Inherited_from: \Task::$target

string
                 $taskName= ''

inherited

Taskname for loggerInherited from: \Task::$taskName

Details

Type: string
Inherited_from: \Task::$taskName

string
                 $taskType= ''

inherited

internal taskname (req)Inherited from: \Task::$taskType

Details

Type: string
Inherited_from: \Task::$taskType

\RuntimeConfigurable
                 $wrapper= ''

inherited

wrapper of the taskInherited from: \Task::$wrapper

Details

Type: \RuntimeConfigurable
Inherited_from: \Task::$wrapper

Methods

getDescription(
          
          )
        
        :
          string

inherited

Returns the textual description of the task

Inherited from: \Task::getDescription()

Returns

Type	Description
string	The text description of the task

getForce(
          
          )
        
        :
          void

inherited

Returns the force switch

Inherited from: \SvnBaseTask::getForce()

getIgnoreExternals(
          
          )
        
        :
          void

inherited

Returns the ignore-externals switch

Inherited from: \SvnBaseTask::getIgnoreExternals()

getLocation(
          
          )
        
        :
          \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.

getNoCache(
          
          )
        
        :
          void

inherited

Returns the no-auth-cache switch

Inherited from: \SvnBaseTask::getNoCache()

getOwningTarget(
          
          )
        
        :
          \Target

inherited

Returns the owning target of this task.

Inherited from: \Task::getOwningTarget()

Returns

Type	Description
\Target	The target object that owns this task

getPassword(
          
          )
        
        :
          void

inherited

Returns the password

Inherited from: \SvnBaseTask::getPassword()

getProject(
          
          )
        
        :
          \Project

inherited

Returns a reference to current project

Inherited from: \ProjectComponent::getProject()

Returns

Type	Description
\Project	Reference to current porject object

getRecursive(
          
          )
        
        :
          void

inherited

Returns the non-recursive switch

Inherited from: \SvnBaseTask::getRecursive()

getRegisterSlot(
           $slotName
          )
        
        :
          void

inherited

Returns a name

Inherited from: \Task::getRegisterSlot()

Parameters

Name	Type	Description
$slotName

getRepositoryUrl(
          
          )
        
        :
          void

inherited

Returns the path/URI to the repository

Inherited from: \SvnBaseTask::getRepositoryUrl()

getRevision(
          
          )
        
        :
          void

getRuntimeConfigurableWrapper(
          
          )
        
        :
          \RuntimeConfigurable

inherited

Returns the wrapper object for runtime configuration

Inherited from: \Task::getRuntimeConfigurableWrapper()

Returns

Type	Description
\RuntimeConfigurable	The wrapper object used by this task

getSvnPath(
          
          )
        
        :
          void

inherited

Returns the path to the SVN executable

Inherited from: \SvnBaseTask::getSvnPath()

getTaskName(
          
          )
        
        :
          string

inherited

Returns the name of task, used only for log messages

Inherited from: \Task::getTaskName()

Returns

Type	Description
string	Name of this task

getTaskType(
          
          )
        
        :
          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)

getToDir(
          
          )
        
        :
          void

inherited

Returns the path to export/checkout to

Inherited from: \SvnBaseTask::getToDir()

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.

Throws

Exception	Description
\BuildException

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

inherited

Provides a project level log event to the task.

Inherited from: \Task::log()

@param string $msg The message to be logged.

Parameters

Name	Type	Description
$msg	string	The message to log
$level	integer	The priority of the message

Details

See: \BuildEvent
See: \BuildListener

The main entry point

Should throw a BuildException if someting goes wrong with the build

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

Throws

Exception	Description
\BuildException

maybeConfigure(
          
          )
        
        :
          void

inherited

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

Inherited from: \Task::maybeConfigure()

perform(
          
          )
        
        :
          void

inherited

Perfrom this task

Inherited from: \Task::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(
          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

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

setNoCache(
           $value
          )
        
        :
          void

inherited

Sets the no-auth-cache switch

Inherited from: \SvnBaseTask::setNoCache()

Parameters

Name	Type	Description
$value

setOwningTarget(
          \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

setPassword(
           $value
          )
        
        :
          void

inherited

Sets the password of the user to export

Inherited from: \SvnBaseTask::setPassword()

Parameters

Name	Type	Description
$value

setProject(
          \Project $project
          )
        
        :
          void

inherited

References the project to the current component.

Inherited from: \ProjectComponent::setProject()

Parameters

Name	Type	Description
$project	\Project	The reference to the current project

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

setSvnPath(
           $svnPath
          )
        
        :
          void

inherited

Sets the path to the SVN executable

Inherited from: \SvnBaseTask::setSvnPath()

Parameters

Name	Type	Description
$svnPath

setTaskName(
           $name
          )
        
        :
          string

inherited

Sets the name of this task for log messages

Inherited from: \Task::setTaskName()

Parameters

Name	Type	Description
$name

Returns

Type	Description
string	A string representing the name of this task for log

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

setToDir(
           $toDir
          )
        
        :
          void

inherited

Sets the path to export/checkout to

Inherited from: \SvnBaseTask::setToDir()

Parameters

Name	Type	Description
$toDir

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/SvnSwitchTask.php

\SvnSwitchTaskjump to top

Properties

Methods

\SvnSwitchTask
jump to top