Freeside:3:Documentation:Developer/FS/part export/print template

From Freeside
Jump to: navigation, search

NAME

FS::part_export::print_template

SYNOPSIS

Print a document of a template.

DESCRIPTION

See the Text::Template documentation and the billing documentation for details on the template substitution language.

Currently does not support printing during replace.

Hook Methods

Each of these simply invoke this module's print_template method, passing the appropriate phase.

_export_insert

Hook that is called when service is initially provisioned. To avoid confusion, don't use for anything else.

_export_delete

Hook that is called when service is unprovisioned. To avoid confusion, don't use for anything else.

_export_replace

Hook that is called when provisioned service is edited. To avoid confusion, don't use for anything else.

Currently not supported for this export.

_export_suspend

Hook that is called when service is suspended. To avoid confusion, don't use for anything else.

_export_unsuspend

Hook that is called when service is unsuspended. To avoid confusion, don't use for anything else.

Core Methods

print_template

Accepts $phase and $svc_x. If phase matches the configured option, starts a "process_print_template" job in the queue.

process_print_template

For use as an FS::queue job. Requires opts svcnum, table and template_text. Constructs page from template and sends to printer.

SEE ALSO

FS::part_export

AUTHOR

Jonathan Prykop jonathan@freeside.biz