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

Class: VersionControl_SVN_Command_Cleanup

Source Location: /VersionControl_SVN-0.5.1/SVN/Command/Cleanup.php

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Cleanup

Subversion Cleanup command manager class


Author(s):

Version:

  • 0.5.1

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()
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 105]
Subversion Cleanup command manager class

Recursively clean up the working copy indicated by PATH, removing locks, resuming unfinished operations, etc.

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

  1.  $switches = array(
  2.   'config-dir'    =>  'Path to a Subversion configuration directory',
  3.   'diff3-cmd'     =>  'ARG'
  4.                       // Use ARG as merge command.
  5.  );

If a path is not used in the $args array, the default path of '.' will be assumed.

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

Note: There is no output from the svn cleanup command!

Usage example:

  1.  <?php
  2.  require_once 'VersionControl/SVN.php';
  3.  
  4.  // Pass array of subcommands we need to factory
  5.  $svn VersionControl_SVN::factory(array('cleanup')$options);
  6.  
  7.  // Define any switches and aguments we may need
  8.  $args = array('/path/to/working_copy');
  9.  
  10.  // Run command
  11.  try {
  12.      print_r($svn->cleanup->run($args$switches));
  13.  catch (VersionControl_SVN_Exception $e{
  14.      print_r($e->getMessage());
  15.  }
  16.  ?>



[ Top ]


Method Detail

__construct (Constructor)   [line 110]

VersionControl_SVN_Command_Cleanup __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 Sat, 09 Feb 2013 12:30:09 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.