PHP Class Ingo_Script_Procmail_Comment, horde

Author: Ben Chavet ([email protected])
Author: Jan Schneider ([email protected])
Inheritance: implements Ingo_Script_Item
Mostrar archivo Open project: horde/horde Class Usage Examples

Protected Properties

Property Type Description
$_comment string The comment text.

Public Methods

Method Description
__construct ( string $comment, boolean $disable = false, boolean $header = false ) Constructs a new procmail comment.
generate ( ) : string Returns the comment stored by this object.

Method Details

__construct() public method

Constructs a new procmail comment.
public __construct ( string $comment, boolean $disable = false, boolean $header = false )
$comment string Comment to be generated.
$disable boolean Output 'DISABLED' comment?
$header boolean Output a 'header' comment?

generate() public method

Returns the comment stored by this object.
public generate ( ) : string
return string The comment stored by this object.

Property Details

$_comment protected_oe property

The comment text.
protected string $_comment
return string