PHP Class Components_Helper_Commit, horde

Copyright 2010-2016 Horde LLC (http://www.horde.org/) See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.
Show file Open project: horde/horde Class Usage Examples

Public Methods

Method Description
__construct ( Components_Output $output, array $options ) Constructor.
add ( string $path, string $directory ) : null Add a path to be included in the commit and record the working directory for this git operation.
commit ( string $log ) : null Add all modified files and commit them.
tag ( string $tag, string $message, string $directory ) : null Tag the component.

Protected Methods

Method Description
system ( string $call ) : string Run a system call.
systemInDirectory ( string $call, string $target_dir ) : string Run a system call.

Method Details

__construct() public method

Constructor.
public __construct ( Components_Output $output, array $options )
$output Components_Output The output handler.
$options array Applicaiton options.

add() public method

Add a path to be included in the commit and record the working directory for this git operation.
public add ( string $path, string $directory ) : null
$path string The path to the modified file.
$directory string The working directory.
return null

commit() public method

Add all modified files and commit them.
public commit ( string $log ) : null
$log string The commit message.
return null

system() protected method

Run a system call.
protected system ( string $call ) : string
$call string The system call to execute.
return string The command output.

systemInDirectory() protected method

Run a system call.
protected systemInDirectory ( string $call, string $target_dir ) : string
$call string The system call to execute.
$target_dir string Run the command in the provided target path.
return string The command output.

tag() public method

Tag the component.
public tag ( string $tag, string $message, string $directory ) : null
$tag string Tag name.
$message string Tag message.
$directory string The working directory.
return null