VersionControl_SVN
[ class tree: VersionControl_SVN ] [ index: VersionControl_SVN ] [ all elements ]

Class: VersionControl_SVN_Command_Move

Source Location: /VersionControl_SVN-0.5.2/VersionControl/SVN/Command/Move.php

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Move

Subversion Move command manager class


Author(s):

Version:

  • 0.5.2

Copyright:

  • 2004-2007 Clay Loveless

Methods


Inherited Variables

Inherited Methods

Class: VersionControl_SVN_Command

VersionControl_SVN_Command::__construct()
Constructor. Can't be called directly as class is abstract.
VersionControl_SVN_Command::checkCommandRequirements()
Standardized validation of requirements for a command class.
VersionControl_SVN_Command::fillSwitch()
Fills the switches array on given name with value if not already set and value is not null.
VersionControl_SVN_Command::parseOutput()
Handles output parsing of standard and verbose output of command.
VersionControl_SVN_Command::postProcessSwitches()
Called after handling switches.
VersionControl_SVN_Command::prepare()
Prepare the command switches.
VersionControl_SVN_Command::preProcessSwitches()
Called before handling switches.
VersionControl_SVN_Command::run()
Run the command with the defined switches.
VersionControl_SVN_Command::setOptions()
Allow for overriding of previously declared options.

Class Details

[line 145]
Subversion Move command manager class

Move and/or rename something in working copy or repository.

Note: this subcommand is equivalent to a 'copy' and 'delete'.

SRC and DST can both be working copy (WC) paths or URLs: WC -> WC: move and schedule for addition (with history) URL -> URL: complete server-side rename.

Copies must include a message option (either with 'm', 'message', 'file' or 'F' keys), but the message itself may be blank.

$switches is an array containing one or more command line options defined by the following associative keys:

  1.  $switches = array(
  2.   'm [message]'   =>  'Specified commit message',
  3.                       // either 'm' or 'message' may be used
  4.   'F [file]'      =>  'Read commit message data from specified file',
  5.                       // either 'F' or 'file' may be used
  6.   'q [quiet]'     =>  true|false,
  7.                       // prints as little as possible
  8.   'force'         =>  true|false,
  9.                       // force operation to run
  10.   'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  11.                         A revision argument can be one of:
  12.                            NUMBER       revision number
  13.                            "{" DATE "}" revision at start of the date
  14.                            "HEAD"       latest in repository
  15.                            "BASE"       base rev of item's working copy
  16.                            "COMMITTED"  last commit at or before BASE
  17.                            "PREV"       revision just before COMMITTED',
  18.                       // either 'r' or 'revision' may be used
  19.   'force-log'     =>  true|false,
  20.                       // force validity of log message source
  21.   'username'      =>  'Subversion repository login',
  22.   'password'      =>  'Subversion repository password',
  23.   'no-auth-cache' =>  true|false,
  24.                       // Do not cache authentication tokens
  25.   'encoding'      =>  'ARG',
  26.                       // treat value as being in charset encoding ARG
  27.   'config-dir'    =>  'Path to a Subversion configuration directory'
  28.  );

Note: Subversion does not offer an XML output option for this subcommand

The non-interactive option available on the command-line svn client may also be set (true|false), but it is set to true by default.

The editor-cmd option available on the command-line svn client is not available since this class does not operate as an interactive shell session.

Usage example:

  1.  <?php
  2.  require_once 'VersionControl/SVN.php';
  3.  
  4.  // Set up runtime options. Will be passed to all
  5.  // subclasses.
  6.  $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
  7.  
  8.  // Pass array of subcommands we need to factory
  9.  $svn VersionControl_SVN::factory(array('move')$options);
  10.  
  11.  // Define any switches and aguments we may need
  12.  $switches = array('m' => 'Whoops! How did this get here?''username' => 'user''password' => 'pass');
  13.  $args = array(
  14.       'svn://svn.example.com/repos/TestProj/trunk/somedir',           // SRC
  15.       'svn://svn.example.com/repos/TestProj/trunk/lowerlevel/somedir' // DST
  16.  );
  17.  
  18.  // Run command
  19.  try {
  20.      print_r($svn->move->run($args$switches));
  21.  catch (VersionControl_SVN_Exception $e{
  22.      print_r($e->getMessage());
  23.  }
  24.  ?>



[ Top ]


Method Detail

__construct (Constructor)   [line 150]

VersionControl_SVN_Command_Move __construct( )

Constuctor of command. Adds available switches.
  • Access: public

Overrides VersionControl_SVN_Command::__construct() (Constructor. Can't be called directly as class is abstract.)
[ Top ]


Documentation generated on Mon, 29 Sep 2014 09:00:06 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.