1 package SL::ReportGenerator;
5 use List::Util qw(max);
11 # Cause locales.pl to parse these files:
12 # parse_html_template('report_generator/html_report')
19 $self->{myconfig} = shift;
20 $self->{form} = shift;
24 'std_column_visibility' => 0,
25 'output_format' => 'HTML',
26 'allow_pdf_export' => 1,
27 'allow_csv_export' => 1,
28 'html_template' => 'report_generator/html_report',
31 'orientation' => 'landscape',
32 'font_name' => 'Verdana',
36 'margin_bottom' => 1.5,
37 'margin_right' => 1.5,
47 'eol_style' => 'Unix',
53 'variable_list' => [],
56 $self->{data_present} = 0;
60 $self->set_options(@_) if (@_);
69 $self->{columns} = \%columns;
71 foreach my $column (values %{ $self->{columns} }) {
72 $column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
75 $self->set_column_order(sort keys %{ $self->{columns} });
78 sub set_column_order {
81 $self->{column_order} = [ grep { !$seen{$_}++ } @_, sort keys %{ $self->{columns} } ];
84 sub set_sort_indicator {
87 $self->{options}->{sort_indicator_column} = shift;
88 $self->{options}->{sort_indicator_direction} = shift;
96 while (my $arg = shift) {
99 if ('ARRAY' eq ref $arg) {
102 } elsif ('HASH' eq ref $arg) {
106 $self->{form}->error('Incorrect usage -- expecting hash or array ref');
109 my @columns_with_default_alignment = grep { defined $self->{columns}->{$_}->{align} } keys %{ $self->{columns} };
111 foreach my $row (@{ $row_set }) {
112 foreach my $column (@columns_with_default_alignment) {
113 $row->{$column} ||= { };
114 $row->{$column}->{align} = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
117 foreach my $field (qw(data link)) {
118 map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
122 push @{ $self->{data} }, $row_set;
123 $last_row_set = $row_set;
125 $self->{data_present} = 1;
128 return $last_row_set;
134 push @{ $self->{data} }, { 'type' => 'separator' };
141 push @{ $self->{data} }, $data;
148 $self->{data_present} = 0;
155 while (my ($key, $value) = each %options) {
156 if ($key eq 'pdf_export') {
157 map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
159 $self->{options}->{$key} = $value;
164 sub set_options_from_form {
167 my $form = $self->{form};
168 my $myconfig = $self->{myconfig};
170 foreach my $key (qw(output_format)) {
171 my $full_key = "report_generator_${key}";
172 $self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
175 foreach my $format (qw(pdf csv)) {
176 my $opts = $self->{options}->{"${format}_export"};
177 foreach my $key (keys %{ $opts }) {
178 my $full_key = "report_generator_${format}_options_${key}";
179 $opts->{$key} = $key =~ /^margin/ ? $form->parse_amount($myconfig, $form->{$full_key}) : $form->{$full_key};
184 sub set_export_options {
189 'variable_list' => [ @_ ],
193 sub set_custom_headers {
197 $self->{custom_headers} = [ @_ ];
199 delete $self->{custom_headers};
203 sub get_attachment_basename {
205 my $filename = $self->{options}->{attachment_basename} || 'report';
206 $filename =~ s|.*\\||;
207 $filename =~ s|.*/||;
212 sub generate_with_headers {
214 my $format = lc $self->{options}->{output_format};
215 my $form = $self->{form};
217 if (!$self->{columns}) {
218 $form->error('Incorrect usage -- no columns specified');
221 if ($format eq 'html') {
222 my $title = $form->{title};
223 $form->{title} = $self->{title} if ($self->{title});
225 $form->{title} = $title;
227 print $self->generate_html_content();
229 } elsif ($format eq 'csv') {
230 my $filename = $self->get_attachment_basename();
231 print qq|content-type: text/csv\n|;
232 print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
233 $self->generate_csv_content();
235 } elsif ($format eq 'pdf') {
236 $self->generate_pdf_content();
239 $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
243 sub get_visible_columns {
247 return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /\Q${format}\E/i)) } @{ $self->{column_order} };
254 $value = $main::locale->quote_special_chars('HTML', $value);
256 $value =~ s/\n/<br>/g;
261 sub prepare_html_content {
264 my ($column, $name, @column_headers);
266 my $opts = $self->{options};
267 my @visible_columns = $self->get_visible_columns('HTML');
269 foreach $name (@visible_columns) {
270 $column = $self->{columns}->{$name};
274 'align' => $column->{align},
275 'link' => $column->{link},
276 'text' => $column->{text},
277 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
278 'sort_indicator_direction' => $opts->{sort_indicator_direction},
281 push @column_headers, $header;
285 if ($self->{custom_headers}) {
286 $header_rows = $self->{custom_headers};
288 $header_rows = [ \@column_headers ];
291 my ($outer_idx, $inner_idx) = (0, 0);
295 foreach my $row_set (@{ $self->{data} }) {
296 if ('HASH' eq ref $row_set) {
297 if ($row_set->{type} eq 'separator') {
298 if (! scalar @rows) {
299 $next_border_top = 1;
301 $rows[-1]->{BORDER_BOTTOM} = 1;
309 'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
310 'NUM_COLUMNS' => scalar @visible_columns,
311 'BORDER_TOP' => $next_border_top,
312 'data' => $row_set->{data},
315 push @rows, $row_data;
317 $next_border_top = 0;
324 foreach my $row (@{ $row_set }) {
327 my $output_columns = [ ];
329 foreach my $col_name (@visible_columns) {
335 my $col = $row->{$col_name};
336 $col->{CELL_ROWS} = [ ];
337 foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
338 push @{ $col->{CELL_ROWS} }, {
339 'data' => $self->html_format($col->{data}->[$i]),
340 'link' => $col->{link}->[$i],
344 # Force at least a to be displayed so that browsers
345 # will format the table cell (e.g. borders etc).
346 if (!scalar @{ $col->{CELL_ROWS} }) {
347 push @{ $col->{CELL_ROWS} }, { 'data' => ' ' };
348 } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
349 $col->{CELL_ROWS}->[0]->{data} = ' ';
352 push @{ $output_columns }, $col;
353 $skip_next = $col->{colspan} ? $col->{colspan} - 1 : 0;
357 'COLUMNS' => $output_columns,
358 'outer_idx' => $outer_idx,
359 'outer_idx_odd' => $outer_idx % 2,
360 'inner_idx' => $inner_idx,
361 'BORDER_TOP' => $next_border_top,
364 push @rows, $row_data;
366 $next_border_top = 0;
370 my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} });
372 my $allow_pdf_export = $opts->{allow_pdf_export};
374 eval { require PDF::API2; require PDF::Table; };
375 $allow_pdf_export |= 1 if (! $@);
378 'TITLE' => $opts->{title},
379 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
380 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
381 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
382 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
383 'ALLOW_PDF_EXPORT' => $allow_pdf_export,
384 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export},
385 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
386 'HEADER_ROWS' => $header_rows,
387 'NUM_COLUMNS' => scalar @column_headers,
389 'EXPORT_VARIABLES' => \@export_variables,
390 'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
391 'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
392 'DATA_PRESENT' => $self->{data_present},
398 sub generate_html_content {
400 my $variables = $self->prepare_html_content();
402 return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
408 return $_[0] * 72 / 2.54;
415 $text = decode('UTF-8', $text) if ($self->{text_is_utf8});
420 sub generate_pdf_content {
427 my $variables = $self->prepare_html_content();
428 my $form = $self->{form};
429 my $myconfig = $self->{myconfig};
431 my $opts = $self->{options};
432 my $pdfopts = $opts->{pdf_export};
434 my (@data, @column_props, @cell_props);
436 my ($data_row, $cell_props_row);
437 my @visible_columns = $self->get_visible_columns('HTML');
438 my $num_columns = scalar @visible_columns;
439 my $num_header_rows = 1;
441 my $font_encoding = $main::dbcharset || 'ISO-8859-15';
442 $self->{text_is_utf8} = $font_encoding =~ m/^utf-?8$/i;
444 foreach $name (@visible_columns) {
445 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
448 if (!$self->{custom_headers}) {
450 $cell_props_row = [];
451 push @data, $data_row;
452 push @cell_props, $cell_props_row;
454 foreach $name (@visible_columns) {
455 $column = $self->{columns}->{$name};
457 push @{ $data_row }, $self->_decode_text($column->{text});
458 push @{ $cell_props_row }, {};
462 $num_header_rows = scalar @{ $self->{custom_headers} };
464 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
466 $cell_props_row = [];
467 push @data, $data_row;
468 push @cell_props, $cell_props_row;
470 foreach my $custom_header_col (@{ $custom_header_row }) {
471 push @{ $data_row }, $self->_decode_text($custom_header_col->{text});
473 my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
474 if ($num_output > 1) {
475 push @{ $data_row }, ('') x ($num_output - 1);
476 push @{ $cell_props_row }, { 'colspan' => $num_output };
477 push @{ $cell_props_row }, ({ }) x ($num_output - 1);
480 push @{ $cell_props_row }, {};
486 foreach my $row_set (@{ $self->{data} }) {
487 if ('HASH' eq ref $row_set) {
488 if ($row_set->{type} eq 'colspan_data') {
489 push @data, [ $self->_decode_text($row_set->{data}) ];
491 $cell_props_row = [];
492 push @cell_props, $cell_props_row;
494 foreach (0 .. $num_columns - 1) {
495 push @{ $cell_props_row }, { 'background_color' => '#666666',
496 'font_color' => '#ffffff',
497 'colspan' => $_ == 0 ? -1 : undef, };
503 foreach my $row (@{ $row_set }) {
505 $cell_props_row = [];
507 push @data, $data_row;
508 push @cell_props, $cell_props_row;
511 foreach my $col_name (@visible_columns) {
512 my $col = $row->{$col_name};
513 push @{ $data_row }, $self->_decode_text(join("\n", @{ $col->{data} }));
515 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
517 my $cell_props = { };
518 push @{ $cell_props_row }, $cell_props;
520 if ($col->{colspan} && $col->{colspan} > 1) {
521 $cell_props->{colspan} = $col->{colspan};
529 foreach my $i (0 .. scalar(@data) - 1) {
530 my $aref = $data[$i];
531 my $num_columns_here = scalar @{ $aref };
533 if ($num_columns_here < $num_columns) {
534 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
535 } elsif ($num_columns_here > $num_columns) {
536 splice @{ $aref }, $num_columns;
541 'a3' => [ 842, 1190 ],
542 'a4' => [ 595, 842 ],
543 'a5' => [ 420, 595 ],
544 'letter' => [ 612, 792 ],
545 'legal' => [ 612, 1008 ],
548 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
550 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
551 my ($paper_width, $paper_height);
553 if (lc $pdfopts->{orientation} eq 'landscape') {
554 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
556 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
559 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
560 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
561 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
562 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
564 my $table = PDF::Table->new();
565 my $pdf = PDF::API2->new();
566 my $page = $pdf->page();
568 $pdf->mediabox($paper_width, $paper_height);
570 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
571 '-encoding' => $font_encoding);
572 my $font_size = $pdfopts->{font_size} || 7;
573 my $title_font_size = $font_size + 1;
575 my $font_height = $font_size + 2 * $padding;
576 my $title_font_height = $font_size + 2 * $padding;
578 my $header_height = 2 * $title_font_height if ($opts->{title});
579 my $footer_height = 2 * $font_height if ($pdfopts->{number});
581 my $top_text_height = 0;
583 if ($self->{options}->{top_info_text}) {
584 my $top_text = $self->_decode_text($self->{options}->{top_info_text});
585 $top_text =~ s/\r//g;
586 $top_text =~ s/\n+$//;
588 my @lines = split m/\n/, $top_text;
589 $top_text_height = $font_height * scalar @lines;
591 foreach my $line_no (0 .. scalar(@lines) - 1) {
592 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
593 my $text_obj = $page->text();
595 $text_obj->font($font, $font_size);
596 $text_obj->translate($margin_left, $y_pos);
597 $text_obj->text($lines[$line_no]);
605 'w' => $paper_width - $margin_left - $margin_right,
606 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
607 'next_y' => $paper_height - $margin_top - $header_height,
608 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
609 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
611 'background_color_odd' => '#ffffff',
612 'background_color_even' => '#eeeeee',
614 'font_size' => $font_size,
615 'font_color' => '#000000',
616 'num_header_rows' => $num_header_rows,
618 'bg_color' => '#ffffff',
620 'font_color' => '#000000',
622 'column_props' => \@column_props,
623 'cell_props' => \@cell_props,
624 'max_word_length' => 60,
627 foreach my $page_num (1..$pdf->pages()) {
628 my $curpage = $pdf->openpage($page_num);
630 if ($pdfopts->{number}) {
631 my $label = $self->_decode_text($main::locale->text("Page #1/#2", $page_num, $pdf->pages()));
632 my $text_obj = $curpage->text();
634 $text_obj->font($font, $font_size);
635 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
636 $text_obj->text($label);
639 if ($opts->{title}) {
640 my $title = $self->_decode_text($opts->{title});
641 my $text_obj = $curpage->text();
643 $text_obj->font($font, $title_font_size);
644 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
645 $paper_height - $margin_top);
646 $text_obj->text($title, '-underline' => 1);
650 my $content = $pdf->stringify();
653 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
654 $form->{printer_id} = $pdfopts->{printer_id};
655 $form->get_printer_code($myconfig);
656 $printer_command = $form->{printer_command};
659 if ($printer_command) {
660 $self->_print_content('printer_command' => $printer_command,
661 'content' => $content,
662 'copies' => $pdfopts->{copies});
663 $form->{report_generator_printed} = 1;
666 my $filename = $self->get_attachment_basename();
668 print qq|content-type: application/pdf\n|;
669 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
675 sub verify_paper_size {
677 my $requested_paper_size = lc shift;
678 my $default_paper_size = shift;
680 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
682 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
689 foreach my $i (1 .. max $params{copies}, 1) {
690 my $printer = IO::File->new("| $params{printer_command}");
691 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
692 $printer->print($params{content});
697 sub unescape_string {
700 my $iconv = $main::locale->{iconv};
702 $text = $main::locale->unquote_special_chars('HTML', $text);
703 $text = $main::locale->{iconv}->convert($text) if ($main::locale->{iconv});
708 sub generate_csv_content {
711 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
712 my %valid_escape_chars = ('"' => 1, "'" => 1);
713 my %valid_quote_chars = ('"' => 1, "'" => 1);
715 my $opts = $self->{options}->{csv_export};
716 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
717 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
718 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
719 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
721 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
723 my $csv = Text::CSV_XS->new({ 'binary' => 1,
724 'sep_char' => $sep_char,
725 'escape_char' => $escape_char,
726 'quote_char' => $quote_char,
729 my $stdout = wraphandle(\*STDOUT);
730 my @visible_columns = $self->get_visible_columns('CSV');
732 if ($opts->{headers}) {
733 if (!$self->{custom_headers}) {
734 $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]);
737 foreach my $row (@{ $self->{custom_headers} }) {
740 foreach my $col (@{ $row }) {
741 my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
742 push @{ $fields }, ($self->unescape_string($col->{text})) x $num_output;
745 $csv->print($stdout, $fields);
750 foreach my $row_set (@{ $self->{data} }) {
751 next if ('ARRAY' ne ref $row_set);
752 foreach my $row (@{ $row_set }) {
755 foreach my $col (@visible_columns) {
761 my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
762 $skip_next = $num_output - 1;
764 push @data, join($eol, map { s/\r?\n/$eol/g; $_ } @{ $row->{$col}->{data} });
765 push @data, ('') x $skip_next if ($skip_next);
768 $csv->print($stdout, \@data);
779 SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
783 my $report = SL::ReportGenerator->new(\%myconfig, $form);
784 $report->set_options(%options); # optional
785 $report->set_columns(%column_defs);
786 $report->set_sort_indicator($column, $direction); # optional
787 $report->add_data($row1, $row2, @more_rows);
788 $report->generate_with_headers();
790 This creates a report object, sets a few columns, adds some data and generates a standard report.
791 Sorting of columns will be alphabetic, and options will be set to their defaults.
792 The report will be printed including table headers, html headers and http headers.
796 Imagine the following scenario:
797 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
798 Then there may be more than one line. You add a loop in the template.
799 Then there are some options made by the user, such as hidden columns. You add more to the template.
800 Then it lacks usability. You want it to be able to sort the data. You add code for that.
801 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
803 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in Lx-Office.
804 It's purpose is to manage all those formating, culling, sorting, and templating.
805 Which makes it almost as complicated to use as doing the work for yourself.
811 =item new \%myconfig,$form,%options
813 Creates a new ReportGenerator object, sets all given options, and returns it.
815 =item set_columns %columns
817 Sets the columns available to this report.
819 =item set_column_order @columns
821 Sets the order of columns. Any columns not present here are appended in alphabetic order.
823 =item set_sort_indicator $column,$direction
825 Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
826 Note that this is only for displaying. The data has to be presented already sorted.
828 =item add_data \@data
830 =item add_data \%data
832 Adds data to the report. A given hash_ref is interpreted as a single line of data, every array_ref as a collection of lines.
833 Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
834 ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
838 Adds a separator line to the report.
840 =item add_control \%data
842 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
843 Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
844 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
848 Deletes all data filled into the report, but keeps options set.
850 =item set_options %options
852 Sets options. For an incomplete list of options, see section configuration.
854 =item set_options_from_form
856 Tries to import options from the $form object given at creation
858 =item set_export_options $next_sub,@variable_list
860 Sets next_sub and additional variables needed for export.
862 =item get_attachment_basename
864 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
866 =item generate_with_headers
868 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
869 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
871 =item get_visible_columns $format
873 Returns a list of columns that will be visible in the report after considering all options or match the given format.
875 =item html_format $value
877 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
879 =item prepare_html_content $column,$name,@column_headers
881 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
882 Should not be called extrenally, since all render and generate functions invoke it anyway.
884 =item generate_html_content
886 The html generation function. Is invoked by generate_with_headers.
888 =item generate_pdf_content
890 The PDF generation function. It is invoked by generate_with_headers, tests whether or not the Perl module PDF::API2 is installed and calls render_pdf_with_pdf_api2 if it is and render_pdf_with_html2ps otherwise.
892 =item generate_csv_content
894 The CSV generation function. Uses XS_CSV to parse the information into csv.
896 =item render_pdf_with_pdf_api2
898 PDF render function using the Perl module PDF::API2.
900 =item render_pdf_with_html2ps
902 PDF render function using the external application html2ps.
908 These are known options and their defaults. Options for pdf export and csv export need to be set as a hashref inside the export option.
910 =head2 General Options
914 =item std_column_visibility
916 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
920 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
922 =item allow_pdf_export
924 Used to determine if a button for PDF export should be displayed. Default is yes. The PDF button is hidden if neither the Perl module PDF::API2 nor the external applications html2ps and Ghostscript are available regardless of this parameter's value.
926 =item allow_csv_export
928 Used to determine if a button for CSV export should be displayed. Default is yes.
932 The template to be used for HTML reports. Default is 'report_generator/html_report'.
942 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
944 =item orientation (landscape)
946 Landscape or portrait. Default is landscape.
950 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
954 Default is 7. This option only affects the rendering with PDF::API2.
964 The paper margins in cm. They all default to 1.5.
968 Set to a true value if the pages should be numbered. Default is 1.
972 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
990 Character to enclose entries. Default is double quote (").
994 Character to separate entries. Default is semicolon (;).
998 Character to escape the quote_char. Default is double quote (").
1002 End of line style. Default is Unix.
1006 Include headers? Default is yes.
1014 =head1 MODULE AUTHORS
1016 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
1018 L<http://linet-services.de>