Class: VersionControl_SVN

Reference array of subcommand shortcuts. Provided for convenience for those who prefer the shortcuts they're used to using with the svn command-line tools.

You may specify your own shortcuts by passing them in to the factory. For example:

 <?php

 require_once 'VersionControl/SVN.php';
 
 $options['shortcuts'] = array('boot' => 'Delete', 'checkin' => 'Commit');
 
 $svn = VersionControl_SVN::factory(array('boot', 'checkin'), $options);
 
 $switches = array(
                 'username' => 'user', 'password' => 'pass', 'force' => true
             );
 $args = array('svn://svn.example.com/repos/TestProject/file_to_delete.txt');
 
 $svn->boot->run($switches, $args);
 
 ?>

Var: Possible shortcuts and their real commands.
Access: public

Type:

array

[ Top ]

Method Detail

apiVersion [line 314]

string apiVersion(
)

Return the VersionControl_SVN API version

Return: The VersionControl_SVN API version number.
Access: public

[ Top ]

factory [line 216]

mixed factory(
string
$command, [array
$options = array()])

Create a new VersionControl_SVN command object.

$options is an array containing multiple options defined by the following associative keys:

 array(

  'username'      => 'Subversion repository login',
  'password'      => 'Subversion repository password',
  'config-dir'    => 'Path to a Subversion configuration directory',
                     // [DEFAULT: null]
  'config-option' => 'Set Subversion user configuration',
                     // [DEFAULT: null]
  'binaryPath'    => 'Path to the svn client binary installed as part of Subversion',
                     // [DEFAULT: /usr/local/bin/svn]
  'fetchmode'     => Type of returning of run function.
                     // [DEFAULT: VERSIONCONTROL_SVN_FETCHMODE_ASSOC]
 )

Example 1.

 <?php

 require_once 'VersionControl/SVN.php';
 
 $options = array(
      'username'   => 'your_login',
      'password'   => 'your_password',
 );
 
 // Run a log command
 $svn = VersionControl_SVN::factory('log', $options);
 
 print_r($svn->run(array('path_to_your_svn'));
 ?>

Return: A newly created command object or an stdObj with the command objects set.
Throws: VersionControl_SVN_Exception Exception if command init fails.
Access: public

Parameters:

string	`$command`	—	The Subversion command
array	`$options`	—	An associative array of option names and their values

[ Top ]

fetchCommands [line 284]

array fetchCommands(
)

Scan through the SVN directory looking for subclasses.

Return: Array with names of commands as value.
Throws: VersionControl_SVN_Exception Exception if fetching commands fails.
Access: public

[ Top ]

init [line 246]

VersionControl_SVN_Command init(
string
$command, array
$options)

Initialize an object wrapper for a Subversion subcommand.

Return: Instance of command.
Throws: VersionControl_SVN_Exception Exception if command init fails.
Access: public

Parameters:

string	`$command`	—	The Subversion command
array	`$options`	—	An associative array of option names and their values

[ Top ]