Documentation

Horde_Release_Sentinel
in package

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.

Tags
category

Horde

author

Mike Hardy

author

Jan Schneider jan@horde.org

author

Gunnar Wrobel wrobel@pardus.de

license

http://www.horde.org/licenses/lgpl21 LGPL 2.1

link
http://www.horde.org/libraries/Horde_Release

Table of Contents

APPLICATION  = '/lib/Application.php'
Path to the Application.php file.
BUNDLE  = '/lib/Bundle.php'
Path to the Bundle.php file.
CHANGES  = '/doc/CHANGES'
Path to the CHANGES file.
CHANGES_H5  = '/docs/CHANGES'
Path to the CHANGES file up to Horde 5.
$_component  : string
Base component path.
__construct()  : mixed
Constructor.
applicationFileExists()  : string|bool
Indicates if there is a Application.php file for this component.
bundleFileExists()  : string|bool
Indicates if there is a Bundle.php file for this component.
changesFileExists()  : string|bool
Indicates if there is a CHANGES file for this component.
getVersion()  : string
Returns the current version from Application.php or Bundle.php.
replaceChanges()  : null
Replace the current sentinel in the CHANGES file in case it exists.
updateApplication()  : null
Update the Application.php or Bundle.php file in case it exists.
updateChanges()  : null
Update the CHANGES file in case it exists.

Constants

APPLICATION

Path to the Application.php file.

public mixed APPLICATION = '/lib/Application.php'

BUNDLE

Path to the Bundle.php file.

public mixed BUNDLE = '/lib/Bundle.php'

CHANGES

Path to the CHANGES file.

public mixed CHANGES = '/doc/CHANGES'

CHANGES_H5

Path to the CHANGES file up to Horde 5.

public mixed CHANGES_H5 = '/docs/CHANGES'

Properties

$_component

Base component path.

private string $_component

Methods

__construct()

Constructor.

public __construct(string $component) : mixed
Parameters
$component : string

Base component path.

Return values
mixed

applicationFileExists()

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

public applicationFileExists() : string|bool
Return values
string|bool

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

bundleFileExists()

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

public bundleFileExists() : string|bool
Return values
string|bool

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

changesFileExists()

Indicates if there is a CHANGES file for this component.

public changesFileExists() : string|bool
Return values
string|bool

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

getVersion()

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

public getVersion() : string
Return values
string

Version string.

replaceChanges()

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

public replaceChanges(string $version) : null
Parameters
$version : string

Version string that should be added.

Return values
null

updateApplication()

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

public updateApplication(mixed $version) : null
Parameters
$version : mixed
Return values
null

updateChanges()

Update the CHANGES file in case it exists.

public updateChanges(string $version) : null
Parameters
$version : string

Version string that should be added.

Return values
null

Search results