internal package Foswiki::Contrib::MailerContrib::Change

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

Child packagesChild packages

internal package Foswiki::Contrib::MailerContrib::Change

Object that represents a change to a topic.

new($web, $topic, $author, $time, $rev)

• $web - Web name
• $topic - Topic name
• $author - String author of change
• $time - String time of change
• $rev - Revision identifier

Construct a new change object.

merge($change)

• $change - Change record to merge

Merge another change record with this one, so that the combined record is a reflection of both changes.

expandHTML($template) → string

• $template - Template to expand keys within

Expand an HTML template using the values in this change. The following keys are expanded: %WEB%, %TOPIC%, %AUTHOR%, %TIME%, %REVISION%, %BASE_REV%, %CUR_REV%, %TEXTHEAD%.

Returns the expanded template.

expandPlain() → string

Generate a plaintext version of this change.

expandDiff($template) → string

Generate a unified diff version of this change.

expandVariables($template, $textHeadAttr) → string

Expand an template using the values in this change. The following keys are expanded:

• %AUTHOR%
• %BASE_REV%
• %CUR_REV%
• %REVISION%
• %TEXTHEAD%
• %TIME%
• %TOPIC%
• %WEB%