phing-tasks-ext-svn

# Class: SvnBaseTask Source Location: /tasks/ext/svn/SvnBaseTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --SvnBaseTask
Base class for Subversion tasks #### Author(s): Andrew Eddie <andrew.eddie@jamboworks.com> Michiel Rook <michiel.rook@gmail.com> #### Version: $Id: SvnBaseTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods getForce getIgnoreExternals getNoCache getPassword getRecursive getRepositoryUrl getSvnPath getToDir getUsername getWorkingCopy init run setForce setIgnoreExternals setNoCache setPassword setRecursive setRepositoryUrl setSvnPath setToDir setup setUsername setWorkingCopy
### Child classes: SvnCopyTask Copies a repository from the repository url to another SvnCheckoutTask Checks out a repository to a local directory SvnCommitTask Commits changes in a local working copy to the repository SvnExportTask Exports/checks out a repository to a local directory with authentication SvnUpdateTask Updates a repository in local directory SvnLastRevisionTask Stores the number of the last revision of a workingcopy in a property | ### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: Task Task::getDescription() Returns the textual description of the task Task::getLocation() Returns the location within the buildfile this task occurs. Used by BuildException to give detailed error messages. Task::getOwningTarget() Returns the owning target of this task. Task::getRegisterSlot() Returns a name Task::getRuntimeConfigurableWrapper() Returns the wrapper object for runtime configuration Task::getTaskName() Returns the name of task, used only for log messages Task::getTaskType() Returns the name of the task under which it was invoked, usually the XML tagname Task::init() Called by the parser to let the task initialize properly. Task::log() Provides a project level log event to the task. Task::main() 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. Task::maybeConfigure() Configure this task if it hasn't been done already. Task::perform() Perfrom this task Task::setDescription() Sets a textual description of the task Task::setLocation() Sets the location within the buildfile this task occurs. Called by the parser to set location information. Task::setOwningTarget() Sets the owning target this task belongs to. Task::setRuntimeConfigurableWrapper() Sets the wrapper object this task should use for runtime configurable elements. Task::setTaskName() Sets the name of this task for log messages Task::setTaskType() Sets the type of the task. Usually this is the name of the XML tag #### Class: ProjectComponent ProjectComponent::getProject() Returns a reference to current project ProjectComponent::log() Logs a message with the given priority. ProjectComponent::setProject() References the project to the current component.
### Class Details [line 34] Base class for Subversion tasks #### Tags:
author: | Andrew Eddie <andrew.eddie@jamboworks.com>
author: | Michiel Rook <michiel.rook@gmail.com>
version: | $Id: SvnBaseTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
see: | VersionControl_SVN
abstract: |
since: | 2.2.0
[ Top ] ### Class Methods ### method getForce [line 148]
`void getForce( )`
Returns the force switch [ Top ] ### method getIgnoreExternals [line 228]
`void getIgnoreExternals( )`
Returns the ignore-externals switch [ Top ] ### method getNoCache [line 196]
`void getNoCache( )`
Returns the no-auth-cache switch [ Top ] ### method getPassword [line 180]
`void getPassword( )`
Returns the password [ Top ] ### method getRecursive [line 212]
`void getRecursive( )`
Returns the non-recursive switch [ Top ] ### method getRepositoryUrl [line 92]
`void getRepositoryUrl( )`
Returns the path/URI to the repository [ Top ] ### method getSvnPath [line 108]
`void getSvnPath( )`
Returns the path to the SVN executable [ Top ] ### method getToDir [line 128]
`void getToDir( )`
Returns the path to export/checkout to [ Top ] ### method getUsername [line 164]
`void getUsername( )`
Returns the username [ Top ] ### method getWorkingCopy [line 76]
`void getWorkingCopy( )`
Returns the path to the workingcopy [ Top ] ### method init [line 58]
`void init( )`
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. Overrides Task::init() (Called by the parser to let the task initialize properly.) [ Top ] ### method run [line 296]
`string run( [array $args = array()], [array $switches = array()])`
Executes the constructed VersionControl_SVN instance #### Tags:
return: | Output generated by SVN.
access: | protected
#### Parameters:
array | $args | Additional arguments to pass to SVN.
array | $switches | Switches to pass to SVN.
[ Top ] ### method setForce [line 140]
`void setForce( $value)`
Sets the force switch #### Parameters:
| $value |
[ Top ] ### method setIgnoreExternals [line 220]
`void setIgnoreExternals( $value)`
Sets the ignore-externals switch #### Parameters:
| $value |
[ Top ] ### method setNoCache [line 188]
`void setNoCache( $value)`
Sets the no-auth-cache switch #### Parameters:
| $value |
[ Top ] ### method setPassword [line 172]
`void setPassword( $value)`
Sets the password of the user to export #### Parameters:
| $value |
[ Top ] ### method setRecursive [line 204]
`void setRecursive( $value)`
Sets the non-recursive switch #### Parameters:
| $value |
[ Top ] ### method setRepositoryUrl [line 84]
`void setRepositoryUrl( $repositoryUrl)`
Sets the path/URI to the repository #### Parameters:
| $repositoryUrl |
[ Top ] ### method setSvnPath [line 100]
`void setSvnPath( $svnPath)`
Sets the path to the SVN executable #### Parameters:
| $svnPath |
[ Top ] ### method setToDir [line 120]
`void setToDir( $toDir)`
Sets the path to export/checkout to #### Parameters:
| $toDir |
[ Top ] ### method setup [line 239]
`void setup( string $mode)`
Creates a VersionControl_SVN class based on $mode #### Tags:
throws: | BuildException
access: | protected
#### Parameters:
string | $mode | The SVN mode to use (info, export, checkout, ...)
[ Top ] ### method setUsername [line 156]
`void setUsername( $value)`
Sets the username of the user to export #### Parameters:
| $value |
[ Top ] ### method setWorkingCopy [line 68]
`void setWorkingCopy( $workingCopy)`
Sets the path to the workingcopy #### Parameters:
| $workingCopy |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:07 +0200 by phpDocumentor 1.4.3