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

Class: VersionControl_SVN_Command_Import

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

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Import

Subversion Import 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 140]
Subversion Import command manager class

Recursively commit an unversioned file or tree into the repository

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

If the 'path' argument is omitted, '.' is assumed. Parent directories are created as necessary in the repository.

$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.   'N'             =>  true|false,
  9.                       // operate on single directory only
  10.   'non-recursive' =>  true|false,
  11.                       // operate on single directory only
  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.   'auto-props'    =>  true|false,
  21.                       // enable automatic properties. Setting to false IS NOT the same
  22.                       // as setting no-auto-props to true.
  23.   'no-auto-props' =>  true|false,
  24.                       // disable automatic properties. Setting to false IS NOT the same
  25.                       // as setting auto-props to true.
  26.   'config-dir'    =>  'Path to a Subversion configuration directory'
  27.  );

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('import')$options);
  10.  
  11.  // Define any switches and aguments we may need
  12.  $switches = array('m' => 'Initial Import - and awwwaaay we go!',
  13.                    'username' => 'user''password' => 'pass');
  14.  $args = array('/path/to/working_copy',
  15.                'svn://svn.example.com/repos/NewProject/');
  16.  
  17.  // Run command
  18.  try {
  19.      print_r($svn->import->run($args$switches));
  20.  catch (VersionControl_SVN_Exception $e{
  21.      print_r($e->getMessage());
  22.  }
  23.  ?>



[ Top ]


Class Variables

$minArgs =  1

[line 149]

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 ]

$requiredSwitches = array('m|message|F|file')

[line 158]

Switches required by this subcommand.

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

  • Access: protected

Type:   array
Overrides:   Array


[ Top ]



Method Detail

__construct (Constructor)   [line 163]

VersionControl_SVN_Command_Import __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.