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

Class: VersionControl_SVN_Command_List

Source Location: /VersionControl_SVN-0.5.1/SVN/Command/List.php

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_List

Subversion List command manager class


Author(s):

Version:

  • 0.5.1

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()
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 133]
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:

  1.  array(
  2.   'r [revision]'  =>  'ARG (some commands also take ARG1:ARG2 range)
  3.                         A revision argument can be one of:
  4.                            NUMBER       revision number
  5.                            "{" DATE "}" revision at start of the date
  6.                            "HEAD"       latest in repository
  7.                            "BASE"       base rev of item's working copy
  8.                            "COMMITTED"  last commit at or before BASE
  9.                            "PREV"       revision just before COMMITTED',
  10.                       // either 'r' or 'revision' may be used
  11.   '[verbose]'   =>  true|false,
  12.                       // prints extra information
  13.   'R'             =>  true|false,
  14.                       // descend recursively
  15.   'recursive'     =>  true|false,
  16.                       // descend recursively
  17.   'username'      =>  'Subversion repository login',
  18.   'password'      =>  'Subversion repository password',
  19.   'no-auth-cache' =>  true|false,
  20.                       // Do not cache authentication tokens
  21.   'config-dir'    =>  'Path to a Subversion configuration directory'
  22.  );

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:

  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('list')$options);
  10.  
  11.  // Define any switches and aguments we may need
  12.  $switches = array('R' => true'username' => 'user''password' => 'pass');
  13.  $args = array('svn://svn.example.com/repos/TestProject');
  14.  
  15.  // Run command
  16.  try {
  17.      print_r($svn->list->run($args$switches));
  18.  catch (VersionControl_SVN_Exception $e{
  19.      print_r($e->getMessage());
  20.  }
  21.  ?>

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



[ Top ]


Class Variables

$xmlAvail =  true

[line 140]

Keep track of whether XML output is available for a command
  • Access: protected

Type:   boolean
Overrides:   Array


[ Top ]



Method Detail

__construct (Constructor)   [line 145]

VersionControl_SVN_Command_List __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 Sat, 09 Feb 2013 12:30:11 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.