Class: VersionControl_SVN

Source Location: /VersionControl_SVN-0.3.0alpha1/SVN.php

Class Overview

Simple OO interface for Subversion

Author(s):

Clay Loveless <clay at killersoft.com>

Version:

@version@

Copyright:

Variables

Methods

Child classes:

VersionControl_SVN_Add: Subversion Add command manager class

VersionControl_SVN_Cat: Subversion Cat command manager class

VersionControl_SVN_Propget: Subversion Propget command manager class

VersionControl_SVN_List: Subversion List command manager class

VersionControl_SVN_Propdel: Subversion Propdel command manager class

VersionControl_SVN_Revert: Subversion Revert command manager class

VersionControl_SVN_Status: Subversion Status command manager class

VersionControl_SVN_Export: Subversion Export command manager class

VersionControl_SVN_Copy: Subversion Copy command manager class

VersionControl_SVN_Import: Subversion Import command manager class

VersionControl_SVN_Diff: Subversion Diff command manager class

VersionControl_SVN_Move: Subversion Move command manager class

VersionControl_SVN_Cleanup: Subversion Cleanup command manager class

VersionControl_SVN_Mkdir: Subversion Mkdir command manager class

VersionControl_SVN_Blame: Subversion Blame command manager class

VersionControl_SVN_Switch: Subversion Switch command manager class

VersionControl_SVN_Proplist: Subversion Proplist command manager class

VersionControl_SVN_Update: Subversion Update command manager class

VersionControl_SVN_Merge: Subversion Merge command manager class

VersionControl_SVN_Delete: Subversion Delete command manager class

VersionControl_SVN_Log: Subversion Log command manager class

VersionControl_SVN_Propset: Subversion Propset command manager class

VersionControl_SVN_Info: Subversion Info command manager class

VersionControl_SVN_Resolved: Subversion Resolved command manager class

VersionControl_SVN_Commit: Subversion Commit command manager class

VersionControl_SVN_Checkout: Subversion Checkout command manager class

Inherited Variables

Inherited Methods

Class Details

[line 132]
Simple OO interface for Subversion

Tutorial: Introduction to using VersionControl_SVN
Author: Clay Loveless <clay@killersoft.com>
Version: @version@
Copyright: Copyright (c) 2004 Clay Loveless. All Rights Reserved.
License: BSD License

[ Top ]

Class Variables

$fetchmode = VERSIONCONTROL_SVN_FETCHMODE_ASSOC

[line 240]

Preferred fetchmode. Note that not all subcommands have output available for each preferred fetchmode. The default cascade is:

VERSIONCONTROL_SVN_FETCHMODE_ASSOC VERSIONCONTROL_SVN_FETCHMODE_RAW

If the specified fetchmode isn't available, raw output will be returned.

Access: public

Type:

int

[ Top ]

$options = array()

[line 226]

Runtime options being used.

Access: public

Type:

array

[ Top ]

$shortcuts = array(

            'praise'    => 'Blame',
            'annotate'  => 'Blame',
            'ann'       => 'Blame',
            'co'        => 'Checkout',
            'ci'        => 'Commit',
            'cp'        => 'Copy',
            'del'       => 'Delete',
            'remove'    => 'Delete',
            'rm'        => 'Delete',
            'di'        => 'Diff',
            'ls'        => 'List',
            'mv'        => 'Move',
            'rename'    => 'Move',
            'ren'       => 'Move',
            'pdel'      => 'Propdel',
            'pd'        => 'Propdel',
            'pget'      => 'Propget',
            'pg'        => 'Propget',
            'plist'     => 'Proplist',
            'pl'        => 'Proplist',
            'pset'      => 'Propset',
            'ps'        => 'Propset',
            'stat'      => 'Status',
            'st'        => 'Status',
            'sw'        => 'Switch',
            'up'        => 'Update'
        )

[line 164]

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);
 
 ?>

Access: public

Type:

array

[ Top ]

$svn_cmd_parser =

[line 248]

XML::Parser class to use for parsing XML output

Access: public

Type:

string

[ Top ]

$svn_path = '/usr/local/bin/svn'

[line 210]

Location of the svn client binary installed as part of Subversion

Access: public

Type:

string

[ Top ]

$switches = array()

[line 218]

Array of switches to use in building svn command

Access: public

Type:

array

[ Top ]

$use_escapeshellcmd = true

[line 202]

Indicates whether commands passed to the exec() function in the run method should be passed through escapeshellcmd().

Access: public

Type:

bool

[ Top ]

Method Detail

apiVersion [line 673]

string apiVersion(
)

Return the VersionControl_SVN API version

Return: the VersionControl_SVN API version number
Access: public

[ Top ]

checkCommandRequirements [line 552]

mixed checkCommandRequirements(
void
0)

Standardized validation of requirements for a command class.

Return: true if all requirements are met, false if requirements are not met. Details of failures are pushed into the PEAR_ErrorStack for VersionControl_SVN
Access: public

Parameters:

void 0 —

[ Top ]

declareErrorMessages [line 311]

array declareErrorMessages(
void
0)

Set up VersionControl_SVN error message templates for PEAR_ErrorStack.

Access: public

Parameters:

void 0 —

[ Top ]

factory [line 394]

mixed &factory(

$command, [array
$options = array()])

Create a new VersionControl_SVN command object.

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

 array(

  'url'           => 'Subversion repository URL',
  'username'      => 'Subversion repository login',
  'password'      => 'Subversion repository password',
  'config_dir'    => 'Path to a Subversion configuration directory',
                     // [DEFAULT: null]
  'dry_run'       => true/false,
                     // [DEFAULT: false]
  'encoding'      => 'Language encoding to use for commit messages',
                     // [DEFAULT: null]
  'svn_path'      => 'Path to the svn client binary installed as part of Subversion',
                     // [DEFAULT: /usr/local/bin/svn]
 )

Example 1.

 <?php

 require_once 'VersionControl/SVN.php';
 
 $options = array(
      'url'        => 'https://www.example.com/repos',
      'path'       => 'your_project',
      'username'   => 'your_login',
      'password'   => 'your_password',
 );
 
 // Run a log command
 $svn = VersionControl_SVN::factory('log', $options);
 
 print_r($svn->run());
 ?>

Return: a newly created VersionControl_SVN command object, or PEAR_ErrorStack constant on error
Access: public

Parameters:

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

[ Top ]

fetchCommands [line 463]

mixed fetchCommands(
)

Scan through the SVN directory looking for subclasses.

Return: array on success, false on failure
Access: public

[ Top ]

fetchShortcuts [line 494]

array fetchShortcuts(
void
0)

Return the array of pre-defined shortcuts (also known as Alternate Names) for Subversion commands.

Access: public

Parameters:

void 0 —

[ Top ]

init [line 425]

mixed init(

$command, 
$options)

Initialize an object wrapper for a Subversion subcommand.

Return: object on success, false on failure
Access: public

Parameters:

	`$command`	—
	`$options`	—

[ Top ]

parseOutput [line 658]

mixed parseOutput(
array
$out)

Handle output parsing chores.

This bare-bones function should be overridden by the command class.

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

Overridden in child classes as:

VersionControl_SVN_Add::parseOutput(): Handles output parsing of output of command.

VersionControl_SVN_Cat::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Propget::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_List::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Propdel::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Revert::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Status::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Export::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Copy::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Import::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Diff::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Move::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Mkdir::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Blame::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Switch::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Proplist::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Update::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Merge::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Delete::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Log::parseOutput(): Handles output parsing of output of Log command.

VersionControl_SVN_Propset::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Info::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Resolved::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Commit::parseOutput(): Handles output parsing of standard and verbose output of command.

VersionControl_SVN_Checkout::parseOutput(): Handles output parsing of standard and verbose output of command.

Parameters:

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

[ Top ]

prepare [line 533]

void prepare(
)

Prepare the command switches.

This function should be overloaded by the command class.

Overridden in child classes as:

VersionControl_SVN_Add::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Cat::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Propget::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_List::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Propdel::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Revert::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Status::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Export::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Copy::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Import::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Diff::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Move::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Cleanup::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Mkdir::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Blame::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Switch::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Proplist::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Update::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Merge::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Delete::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Log::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Propset::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Info::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Resolved::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Commit::prepare(): Prepare the svn subcommand switches.

VersionControl_SVN_Checkout::prepare(): Prepare the svn subcommand switches.

[ Top ]

run [line 608]

mixed run(
[void
$args = array()], [
$switches = array()])

Run the command with the defined switches.

Return: specified output on success, or false on failure.
Access: public

Parameters:

void	`$args`	—
	`$switches`	—

[ Top ]

setOptions [line 507]

void setOptions(
[
$options = array()])

Allow for overriding of previously declared options.

Parameters:

$options —

[ Top ]