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

Class: VersionControl_SVN_Command_Proplist

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

Class Overview

VersionControl_SVN_Command
   |
   --VersionControl_SVN_Command_Proplist

Subversion Proplist 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 128]
Subversion Proplist command manager class

List all properties on files, dirs, or revisions.

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

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

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.

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



[ Top ]


Class Variables

$xmlAvail =  true

[line 135]

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

Type:   boolean
Overrides:   Array


[ Top ]



Method Detail

__construct (Constructor)   [line 140]

VersionControl_SVN_Command_Proplist __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:07 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.