PriceSource: editable Dokumentation
[kivitendo-erp.git] / SL / Helper / PrintOptions.pm
1 package SL::Helper::PrintOptions;
2
3 use strict;
4
5 use List::MoreUtils qw(any);
6
7 sub opthash { +{ value => shift, selected => shift, oname => shift } }
8
9 # generate the printing options displayed at the bottom of oe and is forms.
10 # this function will attempt to guess what type of form is displayed, and will generate according options
11 #
12 # about the coding:
13 # this version builds the arrays of options pretty directly. if you have trouble understanding how,
14 # the opthash function builds hashrefs which are then pieced together for the template arrays.
15 # unneeded options are "undef"ed out, and then grepped out.
16 #
17 # the inline options is untested, but intended to be used later in metatemplating
18 sub get_print_options {
19   my ($class, %params) = @_;
20
21   no warnings 'once';
22
23   my $form     = $params{form}     || $::form;
24   my $myconfig = $params{myconfig} || \%::myconfig;
25   my $locale   = $params{locale}   || $::locale;
26   my $options  = $params{options};
27
28   use warnings 'once';
29
30   my $prefix = $options->{dialog_name_prefix} || '';
31
32   # names 3 parameters and returns a hashref, for use in templates
33   my (@FORMNAME, @LANGUAGE_ID, @FORMAT, @SENDMODE, @MEDIA, @PRINTER_ID, @SELECTS) = ();
34
35   # note: "||"-selection is only correct for values where "0" is _not_ a correct entry
36   $form->{sendmode}   = "attachment";
37   $form->{format}     = $form->{format} || $myconfig->{template_format} || "pdf";
38   $form->{copies}     = $form->{copies} || $myconfig->{copies}          || 3;
39   $form->{media}      = $form->{media}  || $myconfig->{default_media}   || "screen";
40   $form->{printer_id} = defined $form->{printer_id}           ? $form->{printer_id} :
41                         defined $myconfig->{default_printer_id} ? $myconfig->{default_printer_id} : "";
42
43   $form->{PD}{ $form->{formname} } = "selected";
44   $form->{DF}{ $form->{format} }   = "selected";
45   $form->{OP}{ $form->{media} }    = "selected";
46   $form->{SM}{ $form->{sendmode} } = "selected";
47
48   push @FORMNAME, grep $_,
49     ($form->{type} eq 'purchase_order') ? (
50       opthash("purchase_order",      $form->{PD}{purchase_order},      $locale->text('Purchase Order')),
51       opthash("bin_list",            $form->{PD}{bin_list},            $locale->text('Bin List'))
52     ) : undef,
53     ($form->{type} eq 'credit_note') ?
54       opthash("credit_note",         $form->{PD}{credit_note},         $locale->text('Credit Note')) : undef,
55     ($form->{type} eq 'sales_order') ? (
56       opthash("sales_order",         $form->{PD}{sales_order},         $locale->text('Confirmation')),
57       opthash("proforma",            $form->{PD}{proforma},            $locale->text('Proforma Invoice')),
58       opthash("ic_supply",           $form->{PD}{ic_supply},            $locale->text('Intra-Community supply')),
59     ) : undef,
60     ($form->{type} =~ /sales_quotation$/) ?
61       opthash('sales_quotation',     $form->{PD}{sales_quotation},     $locale->text('Quotation')) : undef,
62     ($form->{type} =~ /request_quotation$/) ?
63       opthash('request_quotation',   $form->{PD}{request_quotation},   $locale->text('Request for Quotation')) : undef,
64     ($form->{type} eq 'invoice') ? (
65       opthash("invoice",             $form->{PD}{invoice},             $locale->text('Invoice')),
66       opthash("proforma",            $form->{PD}{proforma},            $locale->text('Proforma Invoice')),
67     ) : undef,
68     ($form->{type} eq 'invoice' && $form->{storno}) ? (
69       opthash("storno_invoice",      $form->{PD}{storno_invoice},      $locale->text('Storno Invoice')),
70     ) : undef,
71     ($form->{type} =~ /_delivery_order$/) ? (
72       opthash($form->{type},         $form->{PD}{$form->{type}},       $locale->text('Delivery Order')),
73       opthash('pick_list',           $form->{PD}{pick_list},           $locale->text('Pick List')),
74     ) : undef,
75     ($form->{type} =~ /^letter$/) ? (
76       opthash('letter',              $form->{PD}{letter},              $locale->text('Letter')),
77     ) : undef;
78
79   push @SENDMODE,
80     opthash("attachment",            $form->{SM}{attachment},          $locale->text('Attachment')),
81     opthash("inline",                $form->{SM}{inline},              $locale->text('In-line'))
82       if ($form->{media} eq 'email');
83
84   my $printable_templates = any { $::lx_office_conf{print_templates}->{$_} } qw(latex opendocument);
85   push @MEDIA, grep $_,
86       opthash("screen",              $form->{OP}{screen},              $locale->text('Screen')),
87     ($printable_templates && $form->{printers} && scalar @{ $form->{printers} }) ?
88       opthash("printer",             $form->{OP}{printer},             $locale->text('Printer')) : undef,
89     ($printable_templates && !$options->{no_queue}) ?
90       opthash("queue",               $form->{OP}{queue},               $locale->text('Queue')) : undef
91         if ($form->{media} ne 'email');
92
93   push @FORMAT, grep $_,
94     ($::lx_office_conf{print_templates}->{opendocument} &&     $::lx_office_conf{applications}->{openofficeorg_writer}  &&     $::lx_office_conf{applications}->{xvfb}
95                                                         && (-x $::lx_office_conf{applications}->{openofficeorg_writer}) && (-x $::lx_office_conf{applications}->{xvfb})
96      && !$options->{no_opendocument_pdf}) ?
97       opthash("opendocument_pdf",    $form->{DF}{"opendocument_pdf"},  $locale->text("PDF (OpenDocument/OASIS)")) : undef,
98     ($::lx_office_conf{print_templates}->{latex}) ?
99       opthash("pdf",                 $form->{DF}{pdf},                 $locale->text('PDF')) : undef,
100     ($::lx_office_conf{print_templates}->{latex} && !$options->{no_postscript}) ?
101       opthash("postscript",          $form->{DF}{postscript},          $locale->text('Postscript')) : undef,
102     (!$options->{no_html}) ?
103       opthash("html", $form->{DF}{html}, "HTML") : undef,
104     ($::lx_office_conf{print_templates}->{opendocument} && !$options->{no_opendocument}) ?
105       opthash("opendocument",        $form->{DF}{opendocument},        $locale->text("OpenDocument/OASIS")) : undef,
106     ($::lx_office_conf{print_templates}->{excel} && !$options->{no_excel}) ?
107       opthash("excel",               $form->{DF}{excel},               $locale->text("Excel")) : undef;
108
109   push @LANGUAGE_ID,
110     map { opthash($_->{id}, ($_->{id} eq $form->{language_id} ? 'selected' : ''), $_->{description}) } +{}, @{ $form->{languages} }
111       if (ref $form->{languages} eq 'ARRAY');
112
113   push @PRINTER_ID,
114     map { opthash($_->{id}, ($_->{id} eq $form->{printer_id} ? 'selected' : ''), $_->{printer_description}) } +{}, @{ $form->{printers} }
115       if ((ref $form->{printers} eq 'ARRAY') && scalar @{ $form->{printers } });
116
117   @SELECTS = map {
118     sname  => $_->[1],
119     DATA   => $_->[0],
120     show   => !$options->{"hide_" . $_->[1]} && scalar @{ $_->[0]},
121     hname  => $locale->text($_->[2])
122   },
123   [ \@FORMNAME,    'formname',    'Formname' ],
124   [ \@LANGUAGE_ID, 'language_id', 'Language' ],
125   [ \@FORMAT,      'format',      'Format'   ],
126   [ \@SENDMODE,    'sendmode',    'Sendmode' ],
127   [ \@MEDIA,       'media',       'Media'    ],
128   [ \@PRINTER_ID,  'printer_id',  'Printer'  ];
129
130   my %dont_display_groupitems = (
131     'dunning' => 1,
132     );
133
134   my %template_vars = (
135     name_prefix          => $prefix || '',
136     show_headers         => $options->{show_headers},
137     display_copies       => scalar @{ $form->{printers} || [] } && $::lx_office_conf{print_templates}->{latex} && $form->{media} ne 'email',
138     display_remove_draft => (!$form->{id} && $form->{draft_id}),
139     display_groupitems   => !$dont_display_groupitems{$form->{type}},
140     display_bothsided    => $options->{show_bothsided},
141     groupitems_checked   => $form->{groupitems} ? "checked" : '',
142     bothsided_checked    => $form->{bothsided}  ? "checked" : '',
143     remove_draft_checked => $form->{remove_draft} ? "checked" : ''
144   );
145
146   return $form->parse_html_template("generic/print_options", { SELECTS  => \@SELECTS, %template_vars } );
147 }
148
149 1;
150
151 __END__
152
153 =pod
154
155 =encoding utf8
156
157 =head1 NAME
158
159 SL::Helper::PrintOptions - A helper for generating the print options for
160 templates
161
162 =head1 SYNOPSIS
163
164   # render your template with print_options
165   $self->render('letter/edit',
166     %params,
167     letter        => $letter,
168     print_options => SL::Helper::PrintOptions->get_print_options (
169       options => { no_postscript   => 1,
170                    no_opendocument => 1,
171                    no_html         => 1,
172                    no_queue        => 1 }),
173
174   );
175
176 Then, in the template, you can render the options with
177     C<[% print_options %]>. Look at the template
178     C<generic/print_options> to see, which variables you get back.
179
180 =head1 FUNCTIONS
181
182 =over 4
183
184 =item C<get_print_options %params>
185
186 Parses the template C<generic/print_options>. It does some guessings
187     and settings according to the params, (namely C<form>).
188
189
190 The recognized parameters are:
191
192 =over 2
193
194 =item * C<form>: defaults to $::form if not given. There are several
195     keys in C<form> which control the output of the options,
196     e.g. C<format>, C<media>, C<copies>, C<printers>, C<printer_id>,
197     C<type>, C<formname>, ...
198
199 =item * C<myconfig>: defaults to %::myconfig
200
201 =item * C<locale>: defaults to $::locale
202
203 =item * C<options>: Options can be:
204
205 * C<dialog_name_prefix>: a string prefixed to the template
206     variables. E.g. if prefix is C<mypref_> the value for copies
207     returned from the user is in $::form->{mypref_copies}
208
209 * C<show_header>: render headings for the input elements
210
211 * C<no_queue>: if set, do not show option for printing to queue
212
213 * C<no_opendocument>: if set, do not show option for printing
214     opendocument format
215
216 * C<no_postscript>: if set, do not show option for printing
217     postscript format
218
219 * C<no_html>: if set, do not show option for printing
220     html format
221
222 * C<no_opendocument_pdf>
223
224 * C<no_excel>
225
226 * and some more
227
228 =back
229
230 =back
231
232 =head1 AUTHOR
233
234 ?
235
236 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt> (I just moved
237     it from io.pl to here and did some minor changes)
238
239 =head1 BUGS
240
241 incomplete documentation
242
243 =cut