Class VC

Description

Version Control generalized library.

$Horde: framework/VC/VC.php,v 1.12.8.14 2008/06/07 16:07:26 chuck Exp $

Located in /VC/VC.php (line 23)


	
			
Direct descendents
Class Description
 class VC_rcs VC_rcs implementation.
 class VC_svn VC_svn implementation.
Variable Summary
 array $_paths
 string $_sourceroot
 array $_users
Method Summary
 VC &factory (mixed $driver, [array $params = array()])
 boolean|string getPath (string $binary)
 boolean|array getUsers ( $usersfile)
 VC &singleton (mixed $driver, [array $params = array()])
 string sourceroot ()
Variables
array $_paths = array() (line 37)

Hash with the locations of all necessary binaries.

string $_sourceroot (line 31)

The source root of the repository.

  • access: protected
array $_users (line 43)

Hash caching the parsed users file.

Methods
factory (line 125)

Attempts to return a concrete VC instance based on $driver.

  • return: The newly created concrete VC instance, or PEAR_Error on failure.
VC &factory (mixed $driver, [array $params = array()])
  • mixed $driver: The type of concrete VC subclass to return. The code is dynamically included.
  • array $params: A hash containing any additional configuration or parameters a subclass might need.
getPath (line 63)

Returns the location of the specified binary.

  • return: The location of the external program or false if it wasn't specified.
boolean|string getPath (string $binary)
  • string $binary: An external program name.
getUsers (line 80)

Parse the users file, if present in the source root, and return a hash containing the requisite information, keyed on the username, and with the 'desc','name', and 'mail' values inside.

  • return: False if the file is not present, otherwise $this->_users populated with the data
boolean|array getUsers ( $usersfile)
  • $usersfile
singleton (line 155)

Attempts to return a reference to a concrete VC instance based on $driver. It will only create a new instance if no VC instance with the same parameters currently exists.

This should be used if multiple types of file backends (and, thus, multiple VC instances) are required.

This method must be invoked as: $var = &VC::singleton()

  • return: The concrete VC reference, or PEAR_Error on failure.
VC &singleton (mixed $driver, [array $params = array()])
  • mixed $driver: The type of concrete VC subclass to return. The code is dynamically included.
  • array $params: A hash containing any additional configuration or parameters a subclass might need.
sourceroot (line 50)

Return the source root for this repository, with no trailing /

  • return: Source root for this repository.
string sourceroot ()

Documentation generated on Sun, 30 Jan 2011 05:23:08 +0000 by phpDocumentor 1.4.3