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

Class: VersionControl_SVN_Command_Revert

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

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Revert

Subversion Revert command manager class


Author(s):

Version:

  • 0.5.2

Copyright:

  • 2004-2007 Clay Loveless

Variables

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 116]
Subversion Revert command manager class

Restore pristine working copy file (undo most local edits).

Note: This subcommand does not require network access, and resolves any conflicted states. However, it does not restore removed directories.

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

  1.  $switches = array(
  2.   'targets'       =>  'ARG',
  3.                       // pass contents of file ARG as additional args
  4.   'R'             =>  true|false,
  5.                       // descend recursively
  6.   'recursive'     =>  true|false,
  7.                       // descend recursively
  8.   'q [quiet]'     =>  true|false,
  9.                       // prints as little as possible
  10.   'config-dir'    =>  'Path to a Subversion configuration directory'
  11.  );

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.

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('revert')$options);
  10.  
  11.  // Define any switches and aguments we may need
  12.  $switches = array('R' => true);
  13.  $args = array('/path/to/working/copy/TestProj/trunk');
  14.  
  15.  // Run command
  16.  try {
  17.      print_r($svn->revert->run($args$switches));
  18.  catch (VersionControl_SVN_Exception $e{
  19.      print_r($e->getMessage());
  20.  }
  21.  ?>



[ Top ]


Class Variables

$minArgs =  1

[line 125]

Minimum number of args required by this subcommand.

See Version Control with Subversion, Subversion Complete Reference for details on arguments for this subcommand.

  • Access: protected

Type:   int
Overrides:   Array


[ Top ]



Method Detail

__construct (Constructor)   [line 130]

VersionControl_SVN_Command_Revert __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:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.