PHP Class Components_Release_Notes, horde

See link: http://pear.horde.org/index.php?package=Components

Author: Gunnar Wrobel ([email protected])

Show file Open project: horde/horde Class Usage Examples

Protected Properties

Property	Type	Description
$_component	Components_Component	The component that should be released
$_notes	array	The release information.
$_output	Components_Output	The task output.

Public Methods

Method	Description
__construct ( Components_Output $output )	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 ( ) : boolean	Returns whether the release is a security release.
hasNotes ( ) : boolean	Does the current component come with release notes?
setComponent ( Components_Component $component ) : null	Set the component this task should act upon.

Protected Methods

Method	Description
_setReleaseNotes ( )	Populates the release information for the current component.

Method Details

__construct() public method

Constructor.

public __construct ( Components_Output $output )
$output	Components_Output	Accepts output.

_setReleaseNotes() protected method

Populates the release information for the current component.

protected _setReleaseNotes ( )

getAnnouncement() public method

Return the announcement text.

public getAnnouncement ( ) : string
return	string	The text.

getBranch() public method

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	string	The branch name.

getList() public method

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

public getList ( ) : string \| null
return	string \| null	The mailing list.

getName() public method

Returns the release name.

public getName ( ) : string
return	string	The release name.

getSecurity() public method

Returns whether the release is a security release.

public getSecurity ( ) : boolean
return	boolean	A security release?

hasNotes() public method

Does the current component come with release notes?

public hasNotes ( ) : boolean
return	boolean	True if release notes are available.

setComponent() public method

Set the component this task should act upon.

public setComponent ( Components_Component $component ) : null
$component	Components_Component	The component to be released.
return	null

Property Details

$_component protected property

The component that should be released

protected Components_Component $_component
return	Components_Component

$_notes protected property

The release information.

protected array $_notes
return	array

$_output protected property

The task output.

protected Components_Output $_output
return	Components_Output