Ingo_Script_Procmail_Comment
in package
implements
Ingo_Script_Item
The Ingo_Script_Procmail_Comment class represents a Procmail comment.
Tags
Interfaces, Classes, Traits and Enums
- Ingo_Script_Item
- The Ingo_Script_Item interface is an interface for individual items representing code snippets of a filter script.
Table of Contents
- $_comment : string
- The comment text.
- __construct() : mixed
- Constructs a new procmail comment.
- generate() : string
- Returns the comment stored by this object.
Properties
$_comment
The comment text.
protected
string
$_comment
= ''
Methods
__construct()
Constructs a new procmail comment.
public
__construct(string $comment[, bool $disable = false ][, bool $header = false ]) : mixed
Parameters
- $comment : string
-
Comment to be generated.
- $disable : bool = false
-
Output 'DISABLED' comment?
- $header : bool = false
-
Output a 'header' comment?
Return values
mixed —generate()
Returns the comment stored by this object.
public
generate() : string
Return values
string —The comment stored by this object.