phing-tasks-ext-svn

# Class: SvnCheckoutTask Source Location: /tasks/ext/svn/SvnCheckoutTask.php
### Class Overview
    ProjectComponent
       |
       --Task
          |
          --SvnBaseTask
             |
             --SvnCheckoutTask
Checks out a repository to a local directory #### Author(s): Andrew Eddie <andrew.eddie@jamboworks.com> #### Version: $Id: SvnCheckoutTask.php 552 2009-08-29 12:18:13Z mrook $ #### Copyright: � 2001,2002 THYRELL. All rights reserved | ### Methods main setRevision
### Inherited Variables #### Class: Task Task::$description Task::$location Task::$target Task::$taskName Task::$taskType Task::$wrapper #### Class: ProjectComponent ProjectComponent::$project | ### Inherited Methods #### Class: SvnBaseTask SvnBaseTask::getForce() Returns the force switch SvnBaseTask::getIgnoreExternals() Returns the ignore-externals switch SvnBaseTask::getNoCache() Returns the no-auth-cache switch SvnBaseTask::getPassword() Returns the password SvnBaseTask::getRecursive() Returns the non-recursive switch SvnBaseTask::getRepositoryUrl() Returns the path/URI to the repository SvnBaseTask::getSvnPath() Returns the path to the SVN executable SvnBaseTask::getToDir() Returns the path to export/checkout to SvnBaseTask::getUsername() Returns the username SvnBaseTask::getWorkingCopy() Returns the path to the workingcopy SvnBaseTask::init() Initialize Task. SvnBaseTask::run() Executes the constructed VersionControl_SVN instance SvnBaseTask::setForce() Sets the force switch SvnBaseTask::setIgnoreExternals() Sets the ignore-externals switch SvnBaseTask::setNoCache() Sets the no-auth-cache switch SvnBaseTask::setPassword() Sets the password of the user to export SvnBaseTask::setRecursive() Sets the non-recursive switch SvnBaseTask::setRepositoryUrl() Sets the path/URI to the repository SvnBaseTask::setSvnPath() Sets the path to the SVN executable SvnBaseTask::setToDir() Sets the path to export/checkout to SvnBaseTask::setup() Creates a VersionControl_SVN class based on $mode SvnBaseTask::setUsername() Sets the username of the user to export SvnBaseTask::setWorkingCopy() Sets the path to the workingcopy #### 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 33] Checks out a repository to a local directory #### Tags:
author: | Andrew Eddie <andrew.eddie@jamboworks.com>
version: | $Id: SvnCheckoutTask.php 552 2009-08-29 12:18:13Z mrook $
copyright: | � 2001,2002 THYRELL. All rights reserved
since: | 2.3.0
[ Top ] ### Class Methods ### method main [line 49]
`void main( )`
The main entry point #### Tags:
throws: | BuildException
Overrides 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.) [ Top ] ### method setRevision [line 63]
`void setRevision( $revision)`
#### Tags:
access: | public
#### Parameters:
| $revision |
[ Top ] Documentation generated on Mon, 19 Oct 2009 10:52:07 +0200 by phpDocumentor 1.4.3