Docs For Class Procmail

Procmail_Comment

Description

The Procmail_Comment:: class represents a Procmail comment. This is a pretty simple class, but it makes the code in Ingo_Script_procmail:: cleaner as it provides a generate() function and can be added to the recipe list the same way as a recipe can be.

author: Ben Chavet <ben@chavet.net>
since: Ingo 1.0

Located in /lib/Script/procmail.php (line 333)

Variable Summary

string $_comment

Method Summary

Procmail_Comment Procmail_Comment (string $comment, [boolean $disable = false], [boolean $header = false])

string generate ()

Variables

string $_comment = '' (line 340)

The comment text.

Methods

Constructor Procmail_Comment (line 349)

Constructs a new procmail comment.

Procmail_Comment Procmail_Comment (string $comment, [boolean $disable = false], [boolean $header = false])

string $comment: Comment to be generated.
boolean $disable: Output 'DISABLED' comment?
boolean $header: Output a 'header' comment?

generate (line 367)

Returns the comment stored by this object.

return: The comment stored by this object.

string generate ()

Documentation generated on Sun, 30 Jan 2011 05:29:28 +0000 by phpDocumentor 1.4.3