Class: VersionControl_SVN_List

Source Location: /VersionControl_SVN-0.3.2/SVN/List.php

Class Overview

VersionControl_SVN
   |
   --VersionControl_SVN_List

Subversion List command manager class

Author(s):

Clay Loveless <clay at killersoft.com>

Version:

0.3.2

Copyright:

2004-2007 Clay Loveless

Inherited Variables

Class: VersionControl_SVN

VersionControl_SVN::$fetchmode
VersionControl_SVN::$options
VersionControl_SVN::$prepend_cmd
VersionControl_SVN::$shortcuts
VersionControl_SVN::$svn_cmd_parser
VersionControl_SVN::$svn_path
VersionControl_SVN::$switches
VersionControl_SVN::$use_escapeshellcmd

Inherited Methods

Class: VersionControl_SVN

VersionControl_SVN::apiVersion(): Return the VersionControl_SVN API version
VersionControl_SVN::checkCommandRequirements(): Standardized validation of requirements for a command class.
VersionControl_SVN::declareErrorMessages(): Set up VersionControl_SVN error message templates for PEAR_ErrorStack.
VersionControl_SVN::factory(): Create a new VersionControl_SVN command object.
VersionControl_SVN::fetchCommands(): Scan through the SVN directory looking for subclasses.
VersionControl_SVN::fetchShortcuts(): Return the array of pre-defined shortcuts (also known as Alternate Names) for Subversion commands.
VersionControl_SVN::init(): Initialize an object wrapper for a Subversion subcommand.
VersionControl_SVN::parseOutput(): Handle output parsing chores.
VersionControl_SVN::prepare(): Prepare the command switches.
VersionControl_SVN::run(): Run the command with the defined switches.
VersionControl_SVN::setOptions(): Allow for overriding of previously declared options.

Class Details

[line 140]
Subversion List command manager class

List directory entries in the repository

If the 'target' option is omitted, '.' is assumed, meaning the repository URL of the current working directory.

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

 array(

  'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
                        A revision argument can be one of:
                           NUMBER       revision number
                           "{" DATE "}" revision at start of the date
                           "HEAD"       latest in repository
                           "BASE"       base rev of item's working copy
                           "COMMITTED"  last commit at or before BASE
                           "PREV"       revision just before COMMITTED',
                      // either 'r' or 'revision' may be used
  'v [verbose]'   =>  true|false,
                      // prints extra information
  'R'             =>  true|false,
                      // descend recursively
  'recursive'     =>  true|false,
                      // descend recursively
  'username'      =>  'Subversion repository login',
  'password'      =>  'Subversion repository password',
  'no-auth-cache' =>  true|false,
                      // Do not cache authentication tokens
  'config-dir'    =>  'Path to a Subversion configuration directory
 );

With the 'verbose' option set to true, the following fields show the status of the item:

Revision number of the last commit Author of the last commit Size (in bytes) Date and time of the last commit

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('list'), $options);
 
 // Define any switches and aguments we may need
 $switches = array('R' => true, 'username' => 'user', 'password' => 'pass');
 $args = array('svn://svn.example.com/repos/TestProject');
 
 // Run command
 if ($output = $svn->list->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'];
         }
     }
 }
 ?>

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

Author: Clay Loveless <clay@killersoft.com>
Version: 0.3.2
Copyright: 2004-2007 Clay Loveless

[ Top ]

Class Variables

$args = array()

[line 171]

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

Access: public

Type:

array

[ Top ]

$min_args = 0

[line 180]

Minimum number of args required by this subcommand.

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

Access: public

Type:

int

[ Top ]

$passthru = false

[line 196]

Use exec or passthru to get results from command.

Access: public

Type:

bool

[ Top ]

$required_switches = array()

[line 189]

Switches required by this subcommand.

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

Access: public

Type:

array

[ Top ]

$valid_switches = array('r',
                                'revision',
                                'v',
                                'verbose',
                                'R',
                                'recursive',
                                'username',
                                'password',
                                'no-auth-cache',
                                'no_auth_cache',
                                'non-interactive',
                                'non_interactive',
                                'config-dir',
                                'config_dir'
                                )

[line 148]

Valid switches for svn list

Access: public

Type:

array

[ Top ]

Method Detail

parseOutput [line 302]

mixed parseOutput(
array
$out)

Handles output parsing of standard and verbose output of command.

Return: Returns output requested by fetchmode (if available), or raw output if desired fetchmode is not available.
Access: public

Overrides VersionControl_SVN::parseOutput() (Handle output parsing chores.)

Parameters:

array $out — Array of output captured by exec command in run.

[ Top ]

parseOutputArray [line 336]

array parseOutputArray(
array
$items)

Helper method for parseOutput that parses output into an associative or numbered array

Access: public

Parameters:

array $items — Item list from the svn list command (already split into an array by exec)

[ Top ]

prepare [line 209]

int prepare(
void
0)

Prepare the svn subcommand switches.

Defaults to non-interactive mode, and will auto-set the --xml switch (if available) if $fetchmode is set to VERSIONCONTROL_SVN_FETCHMODE_XML, VERSIONCONTROL_SVN_FETCHMODE_ASSOC or VERSIONCONTROL_SVN_FETCHMODE_OBJECT

Return: true on success, false on failure. Check PEAR_ErrorStack for error details, if any.

Overrides VersionControl_SVN::prepare() (Prepare the command switches.)

Parameters:

void 0 —

[ Top ]

Class: VersionControl_SVN_List

Class Overview

Author(s):

Version:

Copyright:

Variables

Methods

Inherited Variables

Class: VersionControl_SVN

Inherited Methods

Class: VersionControl_SVN

Class Details

Class Variables

$args = array()

$min_args = 0

$passthru = false

$required_switches = array()

$valid_switches = array('r', 'revision', 'v', 'verbose', 'R', 'recursive', 'username', 'password', 'no-auth-cache', 'no_auth_cache', 'non-interactive', 'non_interactive', 'config-dir', 'config_dir' )

Method Detail

parseOutput [line 302]

Parameters:

parseOutputArray [line 336]

Parameters:

prepare [line 209]

Parameters:

$valid_switches = array('r',
'revision',
'v',
'verbose',
'R',
'recursive',
'username',
'password',
'no-auth-cache',
'no_auth_cache',
'non-interactive',
'non_interactive',
'config-dir',
'config_dir'
)