API Documentation
\

\Horde_Release_Sentinel

Update the sentinel in CHANGES.

Copyright 2011-2017 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Summary

Methods
Properties
Constants
__construct()
updateChanges()
replaceChanges()
updateApplication()
changesFileExists()
applicationFileExists()
bundleFileExists()
getVersion()
No public properties found
CHANGES
CHANGES_H5
APPLICATION
BUNDLE
No protected methods found
No protected properties found
N/A
No private methods found
$_component
N/A

Constants

CHANGES

CHANGES

Path to the CHANGES file.

CHANGES_H5

CHANGES_H5

Path to the CHANGES file up to Horde 5.

APPLICATION

APPLICATION

Path to the Application.php file.

BUNDLE

BUNDLE

Path to the Bundle.php file.

Properties

$_component

$_component : string

Base component path.

Type

string

Methods

__construct()

__construct(string  $component)

Constructor.

Parameters

string $component

Base component path.

updateChanges()

updateChanges(string  $version) : NULL

Update the CHANGES file in case it exists.

Parameters

string $version

Version string that should be added.

Returns

NULL

replaceChanges()

replaceChanges(string  $version) : NULL

Replace the current sentinel in the CHANGES file in case it exists.

Parameters

string $version

Version string that should be added.

Returns

NULL

updateApplication()

updateApplication(  $version) : NULL

Update the Application.php or Bundle.php file in case it exists.

Parameters

$version

Returns

NULL

changesFileExists()

changesFileExists() : string|boolean

Indicates if there is a CHANGES file for this component.

Returns

string|boolean —

The path to the CHANGES file if it exists, false otherwise.

applicationFileExists()

applicationFileExists() : string|boolean

Indicates if there is a Application.php file for this component.

Returns

string|boolean —

The path to the Application.php file if it exists, false otherwise.

bundleFileExists()

bundleFileExists() : string|boolean

Indicates if there is a Bundle.php file for this component.

Returns

string|boolean —

The path to the Bundle.php file if it exists, false otherwise.

getVersion()

getVersion() : string

Returns the current version from Application.php or Bundle.php.

Returns

string —

Version string.