PHP Class Horde_Vcs_Git, horde

Constructor args:

'sourceroot': The source root for this repository
'paths': Hash with the locations of all necessary binaries: 'git'

Author: Chuck Hagenbuch ([email protected])

Author: Michael Slusarz ([email protected])

Inheritance: extends Horde_Vcs_Base

Datei anzeigen Open project: horde/horde

Public Properties

Property	Type	Description
$version	string	The git version

Protected Properties

Property	Type	Description
$_branchlist	array	The list of branches for the repo.
$_diffTypes	array	The available diff types.
$_driver	string	The current driver.
$_features	array	Driver features.

Public Methods

Method	Description
__construct ( $params = [] )
abbrev ( string $rev ) : string	Returns an abbreviated form of the revision, for display.
annotate ( $fileob, $rev )	TODO
checkout ( $file, string $rev ) : resource	Function which returns a file pointing to the head of the requested revision of a file.
getBranchList ( )	TODO
getCommand ( )	TODO
getDefaultBranch ( )
getRevisionRange ( Horde_Vcs_File_Base $file, string $r1, string $r2 ) : array	Create a range of revisions between two revision numbers.
isFile ( $where, $branch = null )	TODO
isValidRevision ( $rev )	TODO
runCommand ( string $args ) : array(resource,	Runs a git commands.

Protected Methods

Method	Description
_diff ( Horde_Vcs_File_Base $file, string $rev1, string $rev2, array $opts ) : string	Obtain the differences between two revisions of a file.
_getRevisionRange ( Horde_Vcs_File_Git $file, $r1, $r2 )	TODO

Method Details

__construct() public method

public __construct ( $params = [] )

_diff() protected method

Obtain the differences between two revisions of a file.

protected _diff ( Horde_Vcs_File_Base $file, string $rev1, string $rev2, array $opts ) : string
$file	Horde_Vcs_File_Base	The desired file.
$rev1	string	Original revision number to compare from.
$rev2	string	New revision number to compare against.
$opts	array	The following optional options: - 'num': (integer) DEFAULT: 3 - 'type': (string) DEFAULT: 'unified' - 'ws': (boolean) DEFAULT: true
return	string	The diff text.

_getRevisionRange() protected method

TODO

protected _getRevisionRange ( Horde_Vcs_File_Git $file, $r1, $r2 )
$file	Horde_Vcs_File_Git

abbrev() public method

Returns an abbreviated form of the revision, for display.

public abbrev ( string $rev ) : string
$rev	string	The revision string.
return	string	The abbreviated string.

annotate() public method

TODO

public annotate ( $fileob, $rev )

checkout() public method

Function which returns a file pointing to the head of the requested revision of a file.

public checkout ( $file, string $rev ) : resource
$rev	string	Revision number to check out
return	resource	A stream pointer to the head of the checkout.

getBranchList() public method

TODO

public getBranchList ( )

getCommand() public method

TODO

public getCommand ( )

getDefaultBranch() public method

public getDefaultBranch ( )

getRevisionRange() public method

Create a range of revisions between two revision numbers.

public getRevisionRange ( Horde_Vcs_File_Base $file, string $r1, string $r2 ) : array
$file	Horde_Vcs_File_Base	The desired file.
$r1	string	The initial revision.
$r2	string	The ending revision.
return	array	The revision range, or empty if there is no straight line path between the revisions.

isFile() public method

TODO

public isFile ( $where, $branch = null )

isValidRevision() public method

TODO

public isValidRevision ( $rev )

runCommand() public method

Uses proc_open() to properly catch errors and returns a stream with the command result. fclose() must be called manually on the returned stream and proc_close() on the resource, once the output stream has been finished reading.

public runCommand ( string $args ) : array(resource,
$args	string	Any arguments for the git command. Must be escaped.
return	array(resource,

Property Details

$_branchlist protected_oe property

The list of branches for the repo.

protected array $_branchlist
return	array

$_diffTypes protected_oe property

The available diff types.

protected array $_diffTypes
return	array

$_driver protected_oe property

The current driver.

protected string $_driver
return	string

$_features protected_oe property

Driver features.

protected array $_features
return	array

$version public_oe property

The git version

public string $version
return	string