Difference between revisions of "Freeside:3:Documentation:Developer/FS/template content"

Latest revision as of 20:06, 27 June 2012

NAME

FS::template_content - Object methods for template_content records

SYNOPSIS

 use FS::template_content;

 $record = new FS::template_content \%hash;
 $record = new FS::template_content { 'column' => 'value' };

 $error = $record->insert;

 $error = $new_record->replace($old_record);

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::template_content object represents the content of a message template (subject line and body) for a specific region. FS::template_content inherits from FS::Record. The following fields are currently supported:

contentnum - primary key; msgnum - the FS::msg_template for which this is the content.; locale - locale (such as 'en_US'); can be NULL.; subject - Subject: line of the message, in Text::Template format.; body - Message body, as plain text or HTML, in Text::Template format.

METHODS

new HASHREF

Creates a new example. To add the example to the database, see "insert".

Note that this stores the hash reference, not a distinct copy of the hash it points to. You can ask the object for a copy with the hash method.

insert

Adds this record to the database. If there is an error, returns the error, otherwise returns false.

delete

Delete this record from the database.

replace OLD_RECORD

Replaces the OLD_RECORD with this one in the database. If there is an error, returns the error, otherwise returns false.

check

Checks all fields to make sure this is a valid example. If there is an error, returns the error, otherwise returns false. Called by the insert and replace methods.

SEE ALSO

FS::Record, schema.html from the base documentation.