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

Class: VersionControl_SVN_Command_Delete

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

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Delete

Subversion Delete 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 136]
Subversion Delete command manager class

Remove files and directories from version control.

  1. Each item specified by a PATH is scheduled for deletion upon the next commit. Files, and directories that have not been committed, are immediately removed from the working copy. PATHs that are, or contain, unversioned or modified items will not be removed unless the 'force' option is given.
2. Each item specified by a URL is deleted from the repository via an immediate commit.

$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 (optional)
  4.   'F [file]'      =>  'Read commit message data from specified file',
  5.                       // either 'F' or 'file' may be used (optional)
  6.   'q [quiet]'     =>  true|false,
  7.                       // prints as little as possible
  8.   'targets'       =>  'ARG',
  9.                       // pass contents of file ARG as additional args
  10.   'force'         =>  true|false,
  11.                       // force operation to run
  12.   'force-log'     =>  true|false,
  13.                       // force validity of log message source
  14.   'username'      =>  'Subversion repository login',
  15.   'password'      =>  'Subversion repository password',
  16.   'no-auth-cache' =>  true|false,
  17.                       // Do not cache authentication tokens
  18.   'encoding'      =>  'ARG',
  19.                       // treat value as being in charset encoding ARG
  20.   'config-dir'    =>  'Path to a Subversion configuration directory'
  21.  );

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('delete')$options);
  10.  
  11.  // Define any switches and aguments we may need
  12.  $switches = array('m' => 'Whoops! Better get rid of this file',
  13.                    'username' => 'user''password' => 'pass');
  14.  $args = array('svn://svn.example.com/repos/TestProj/trunk/template1/bad_index.tpl');
  15.  
  16.  // Run command
  17.  try {
  18.      print_r($svn->delete->run($args$switches));
  19.  catch (VersionControl_SVN_Exception $e{
  20.      print_r($e->getMessage());
  21.  }
  22.  ?>



[ Top ]


Class Variables

$minArgs =  1

[line 145]

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 150]

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