PHP Class Components_Helper_ChangeLog, 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 ) Constructor.
addChange ( string $entry, string $changes ) : null Add a change log entry to CHANGES
changes ( string $log, string $directory, array $options ) : null Update CHANGES file.
changesFileExists ( string $dir ) : string | boolean Indicates if there is a CHANGES file for this component.
getChangelog ( string $root, string $directory ) : string | null Returns the link to the change log.
packageXml ( string $log, Horde_Pear_Package_Xml $xml, string $file, array $options ) : null Update package.xml file.

Protected Methods

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

Method Details

__construct() public method

Constructor.
public __construct ( Components_Output $output )
$output Components_Output The output handler.

addChange() public method

Add a change log entry to CHANGES
public addChange ( string $entry, string $changes ) : null
$entry string Change log entry to add.
$changes string Path to the CHANGES file.
return null

changes() public method

Update CHANGES file.
public changes ( string $log, string $directory, array $options ) : null
$log string The log entry.
$directory string The path to the component directory.
$options array Additional options.
return null

changesFileExists() public method

Indicates if there is a CHANGES file for this component.
public changesFileExists ( string $dir ) : string | boolean
$dir string The basic component directory.
return string | boolean The path to the CHANGES file if it exists, false otherwise.

getChangelog() public method

Returns the link to the change log.
public getChangelog ( string $root, string $directory ) : string | null
$root string The root of the component in the repository.
$directory string The working directory.
return string | null The link to the change log.

packageXml() public method

Update package.xml file.
public packageXml ( string $log, Horde_Pear_Package_Xml $xml, string $file, array $options ) : null
$log string The log entry.
$xml Horde_Pear_Package_Xml The package xml handler.
$file string Path to the package.xml.
$options array Additional options.
return null

system() protected method

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

systemInDirectory() protected method

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