Class: VersionControl_SVN_Import

VersionControl_SVN
   |
   --VersionControl_SVN_Import

[line 147]
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:

 $switches = array(

  'm [message]'   =>  'Specified commit message',
                      // either 'm' or 'message' may be used
  'F [file]'      =>  'Read commit message data from specified file',
                      // either 'F' or 'file' may be used
  'q [quiet]'     =>  true|false,
                      // prints as little as possible
  'N'             =>  true|false,
                      // operate on single directory only
  'non-recursive' =>  true|false,
                      // operate on single directory only
  'force-log'     =>  true|false,
                      // force validity of log message source
  'username'      =>  'Subversion repository login',
  'password'      =>  'Subversion repository password',
  'no-auth-cache' =>  true|false,
                      // Do not cache authentication tokens
  'encoding'      =>  'ARG',
                      // treat value as being in charset encoding ARG
  'auto-props'    =>  true|false,
                      // enable automatic properties. Setting to false IS NOT the same
                      // as setting no-auto-props to true.
  'no-auto-props' =>  true|false,
                      // disable automatic properties. Setting to false IS NOT the same
                      // as setting auto-props to true.
  'config-dir'    =>  'Path to a Subversion configuration directory'
 );

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:

 <?php

 require_once 'VersionControl/SVN.php';
 
 // Setup error handling -- always a good idea!
 $svnstack = &PEAR_ErrorStack::singleton('VersionControl_SVN');
 
 // Set up runtime options. Will be passed to all
 // subclasses.
 $options = array('fetchmode' => VERSIONCONTROL_SVN_FETCHMODE_RAW);
 
 // Pass array of subcommands we need to factory
 $svn = VersionControl_SVN::factory(array('import'), $options);
 
 // Define any switches and aguments we may need
 $switches = array('m' => 'Initial Import - and awwwaaay we go!',
                   'username' => 'user', 'password' => 'pass');
 $args = array('/path/to/working_copy',
               'svn://svn.example.com/repos/NewProject/');
 
 // Run command
 if ($output = $svn->import->run($args, $switches)) {
     print_r($output);
 } else {
     if (count($errs = $svnstack->getErrors())) {
         foreach ($errs as $err) {
             echo '<br />'.$err['message']."<br />\n";
             echo "Command used: " . $err['params']['cmd'];
         }
     }
 }
 ?>

$args = array()

[line 188]

Command-line arguments that should be passed outside of those specified in switches.

$min_args =  1

[line 197]

Minimum number of args required by this subcommand.

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

$passthru =  false

[line 213]

Use exec or passthru to get results from command.

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

[line 206]

Switches required by this subcommand.

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

$valid_switches = array('m',
                                'message',
                                'F',
                                'file',
                                'q',
                                'quiet',
                                'N',
                                'non-recursive',
                                'non_recursive',
                                'username',
                                'password',
                                'no-auth-cache',
                                'no_auth_cache',
                                'non-interactive',
                                'non_interactive',
                                'force-log',
                                'force_log',
                                'encoding',
                                'auto_props',
                                'no-auto-props',
                                'no_auto_props',
                                'config-dir',
                                'config_dir'
                                )

[line 155]

Valid switches for svn import

parseOutput   [line 324]

---

parseOutputArray   [line 357]

---

prepare   [line 226]

---