Documentation

Notes
in package

This class deals with the information associated to a release.

Tags
category

Horde

author

Gunnar Wrobel wrobel@pardus.de

license

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

Table of Contents

$_component  : Component
The component that should be released
$_notes  : array<string|int, mixed>
The release information.
$_output  : Output
__construct()  : mixed
Constructor.
getAnnouncement()  : string
Return the announcement text.
getBranch()  : string
The branch information for this component. This is empty for framework components and the Horde base application and has a value like "H3", "H4", etc. for applications.
getList()  : string|null
Returns the specific mailing list that the release announcement for this component should be sent to.
getName()  : string
Returns the release name.
getSecurity()  : bool
Returns whether the release is a security release.
hasNotes()  : bool
Does the current component come with release notes?
setComponent()  : void
Set the component this task should act upon.
_setReleaseNotes()  : void
Populates the release information for the current component.

Properties

$_component

The component that should be released

protected Component $_component

$_notes

The release information.

protected array<string|int, mixed> $_notes = []

Methods

__construct()

Constructor.

public __construct(Output $_output) : mixed
Parameters
$_output : Output

Accepts output.

Return values
mixed —

getAnnouncement()

Return the announcement text.

public getAnnouncement() : string
Return values
string —

The text.

getBranch()

The branch information for this component. This is empty for framework components and the Horde base application and has a value like "H3", "H4", etc. for applications.

public getBranch() : string
Return values
string —

The branch name.

getList()

Returns the specific mailing list that the release announcement for this component should be sent to.

public getList() : string|null
Return values
string|null —

The mailing list.

getName()

Returns the release name.

public getName() : string
Return values
string —

The release name.

getSecurity()

Returns whether the release is a security release.

public getSecurity() : bool
Return values
bool —

A security release?

hasNotes()

Does the current component come with release notes?

public hasNotes() : bool
Return values
bool —

True if release notes are available.

setComponent()

Set the component this task should act upon.

public setComponent(Component $component) : void
Parameters
$component : Component

The component to be released.

Return values
void —

_setReleaseNotes()

Populates the release information for the current component.

protected _setReleaseNotes() : void
Return values
void —

Search results