X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FHelper%2FCreatePDF.pm;h=8d36eb74920a1871460e139379e8082bb7618b4b;hb=14b824ae47b746673eb94885b0c972fd5a84a62a;hp=6cffc292524eb3dd97e20741374bd97f7b9eb592;hpb=aa925eed40c22fe731ac70b496812f7e5a38e240;p=kivitendo-erp.git
diff --git a/SL/Helper/CreatePDF.pm b/SL/Helper/CreatePDF.pm
index 6cffc2925..8d36eb749 100644
--- a/SL/Helper/CreatePDF.pm
+++ b/SL/Helper/CreatePDF.pm
@@ -33,8 +33,9 @@ sub create_pdf {
$form->{format} = 'pdf';
$form->{cwd} = getcwd();
$form->{templates} = $::instance_conf->get_templates;
- $form->{IN} = $params{template} . '.tex';
+ $form->{IN} = $params{template};
$form->{tmpdir} = $form->{cwd} . '/' . $userspath;
+ my ($suffix) = $params{template} =~ m{\.(.+)};
my $vars = $params{variables} || {};
$form->{$_} = $vars->{$_} for keys %{ $vars };
@@ -42,7 +43,7 @@ sub create_pdf {
my $temp_fh;
($temp_fh, $form->{tmpfile}) = File::Temp::tempfile(
'kivitendo-printXXXXXX',
- SUFFIX => '.tex',
+ SUFFIX => ".${suffix}",
DIR => $userspath,
UNLINK => ($::lx_office_conf{debug} && $::lx_office_conf{debug}->{keep_temp_files})? 0 : 1,
);
@@ -152,3 +153,135 @@ sub find_template {
}
1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::Helper::CreatePDF - A helper for creating PDFs from template files
+
+=head1 SYNOPSIS
+
+ # Retrieve a sales order from the database and create a PDF for
+ # it:
+ my $order = SL::DB::Order->new(id => â¦)->load;
+ my $print_form = Form->new('');
+ $print_form->{type} = 'invoice';
+ $print_form->{formname} = 'invoice',
+ $print_form->{format} = 'pdf',
+ $print_form->{media} = 'file';
+
+ $order->flatten_to_form($print_form, format_amounts => 1);
+ $print_form->prepare_for_printing;
+
+ my $pdf = SL::Helper::CreatePDF->create_pdf(
+ template => 'sales_order',
+ variables => $print_form,
+ );
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C
+
+Parses a LaTeX template file, creates a PDF for it and returns either
+its content or its file name. The recognized parameters are:
+
+=over 2
+
+=item * C â mandatory. The template file name relative to
+the users' templates directory. Must be an existing file name,
+e.g. one retrieved by L.
+
+=item * C â optional hash reference containing variables
+available to the template.
+
+=item * C â optional scalar containing either C (the
+default) or C. If it is set to C then the file
+name of the temporary file containing the PDF is returned, and the
+caller is responsible for deleting it. Otherwise a scalar containing
+the PDF itself is returned and all temporary files have already been
+deleted by L.
+
+=back
+
+=item C
+
+Searches the user's templates directory for a template file name to
+use. The file names considered depend on the parameters; they can
+contain a template base name and suffixes for email, language and
+printers. As a fallback the name C is also
+considered.
+
+The return value depends on the context. In scalar context the
+template file name that matches the given parameters is returned. It's
+a file name relative to the user's templates directory. If no template
+file is found then C is returned.
+
+In list context the first element is the same value as in scalar
+context. Additionally a list of considered template file names is
+returned.
+
+The recognized parameters are:
+
+=over 2
+
+=item * C â mandatory. The template's file name basis
+without any additional suffix or extension, e.g. C.
+
+=item * C â optional file name extension to use without the
+dot. Defaults to C.
+
+=item * C â optional flag indicating whether or not the
+template is to be sent via email. If set to true then template file
+names containing C<_email> are considered as well.
+
+=item * C and C â optional parameters
+indicating the language to be used. C can be either a string
+containing the language code to use or an instance of
+C. C can contain the ID of the
+C instance to load and use. If given template file
+names containing C<_language_template_code> are considered as well.
+
+=item * C and C â optional parameters indicating
+the printer to be used. C can be either a string containing
+the printer code to use or an instance of
+C. C can contain the ID of the
+C instance to load and use. If given template file
+names containing C<_printer_template_code> are considered as well.
+
+=back
+
+=item C
+
+Merges two or more PDFs into a single PDF by using the external
+application ghostscript.
+
+The recognized parameters are:
+
+=over 2
+
+=item * C â mandatory array reference containing the file
+names to merge.
+
+=back
+
+Note that this function relies on the presence of the external
+application ghostscript. The executable to use is configured via
+kivitendo's configuration file setting C.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus Em.bunkus@linet-services.deE
+
+=cut