Freeside:4:Documentation:Developer/FS/template image

From Freeside
Jump to: navigation, search

NAME

FS::template_image - Object methods for template_image records

SYNOPSIS

 use FS::template_image;

 $record = new FS::template_image {
             'name'      => 'logo',
             'agentnum'  => $agentnum,
             'base64'    => encode_base64($rawdata),
             'mime_type' => 'image/jpg',
 };

 $error = $record->insert;

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

 $error = $record->delete;

 $error = $record->check;

DESCRIPTION

An FS::template_image object represents an uploaded image for insertion into templates. FS::template_image inherits from FS::Record. The following fields are currently supported:

imgnum - primary key; name - unique name, for selecting/editing images; agentnum - image agent; mime-type - image mime-type; base64 - base64-encoded raw contents of image file

METHODS

new HASHREF
Creates a new object. To add the object 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.
src
Returns a data url for this image, incorporating mime_type & base64
html
Returns html for a basic img tag for this image (no attributes)
process_image_delete
Process for deleting an image. Run as a job using FS::queue.
process_image_upload
Process for uploading an image. Run as a job using FS::queue.

BUGS

Will be described here once found.

SEE ALSO

FS::Record