1 package SL::ReportGenerator;
4 use List::Util qw(max);
6 #use PDF::API2; # these two eat up to .75s on startup. only load them if we actually need them
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 'controller_class ' => '',
27 'allow_pdf_export' => 1,
28 'allow_csv_export' => 1,
29 'html_template' => 'report_generator/html_report',
32 'orientation' => 'landscape',
33 'font_name' => 'Verdana',
37 'margin_bottom' => 1.5,
38 'margin_right' => 1.5,
48 'eol_style' => 'Unix',
54 'variable_list' => [],
57 $self->{data_present} = 0;
61 $self->set_options(@_) if (@_);
70 $self->{columns} = \%columns;
72 foreach my $column (values %{ $self->{columns} }) {
73 $column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
76 $self->set_column_order(sort keys %{ $self->{columns} });
79 sub set_column_order {
82 $self->{column_order} = [ grep { !$seen{$_}++ } @_, sort keys %{ $self->{columns} } ];
85 sub set_sort_indicator {
88 $self->{options}->{sort_indicator_column} = shift;
89 $self->{options}->{sort_indicator_direction} = shift;
97 while (my $arg = shift) {
100 if ('ARRAY' eq ref $arg) {
103 } elsif ('HASH' eq ref $arg) {
107 $self->{form}->error('Incorrect usage -- expecting hash or array ref');
110 my @columns_with_default_alignment = grep { defined $self->{columns}->{$_}->{align} } keys %{ $self->{columns} };
112 foreach my $row (@{ $row_set }) {
113 foreach my $column (@columns_with_default_alignment) {
114 $row->{$column} ||= { };
115 $row->{$column}->{align} = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
118 foreach my $field (qw(data link)) {
119 map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
123 push @{ $self->{data} }, $row_set;
124 $last_row_set = $row_set;
126 $self->{data_present} = 1;
129 return $last_row_set;
135 push @{ $self->{data} }, { 'type' => 'separator' };
142 push @{ $self->{data} }, $data;
149 $self->{data_present} = 0;
156 while (my ($key, $value) = each %options) {
157 if ($key eq 'pdf_export') {
158 map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
160 $self->{options}->{$key} = $value;
165 sub set_options_from_form {
168 my $form = $self->{form};
169 my $myconfig = $self->{myconfig};
171 foreach my $key (qw(output_format)) {
172 my $full_key = "report_generator_${key}";
173 $self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
176 foreach my $format (qw(pdf csv)) {
177 my $opts = $self->{options}->{"${format}_export"};
178 foreach my $key (keys %{ $opts }) {
179 my $full_key = "report_generator_${format}_options_${key}";
180 $opts->{$key} = $key =~ /^margin/ ? $form->parse_amount($myconfig, $form->{$full_key}) : $form->{$full_key};
185 sub set_export_options {
190 'variable_list' => [ @_ ],
194 sub set_custom_headers {
198 $self->{custom_headers} = [ @_ ];
200 delete $self->{custom_headers};
204 sub get_attachment_basename {
206 my $filename = $self->{options}->{attachment_basename} || 'report';
207 $filename =~ s|.*\\||;
208 $filename =~ s|.*/||;
213 sub generate_with_headers {
215 my $format = lc $self->{options}->{output_format};
216 my $form = $self->{form};
218 if (!$self->{columns}) {
219 $form->error('Incorrect usage -- no columns specified');
222 if ($format eq 'html') {
223 my $title = $form->{title};
224 $form->{title} = $self->{title} if ($self->{title});
226 $form->{title} = $title;
228 print $self->generate_html_content();
230 } elsif ($format eq 'csv') {
231 my $filename = $self->get_attachment_basename();
232 print qq|content-type: text/csv\n|;
233 print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
234 $::locale->with_raw_io(\*STDOUT, sub {
235 $self->generate_csv_content();
238 } elsif ($format eq 'pdf') {
239 $self->generate_pdf_content();
242 $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
246 sub get_visible_columns {
250 return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /\Q${format}\E/i)) } @{ $self->{column_order} };
257 $value = $main::locale->quote_special_chars('HTML', $value);
259 $value =~ s/\n/<br>/g;
264 sub prepare_html_content {
267 my ($column, $name, @column_headers);
269 my $opts = $self->{options};
270 my @visible_columns = $self->get_visible_columns('HTML');
272 foreach $name (@visible_columns) {
273 $column = $self->{columns}->{$name};
277 'align' => $column->{align},
278 'link' => $column->{link},
279 'text' => $column->{text},
280 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
281 'sort_indicator_direction' => $opts->{sort_indicator_direction},
284 push @column_headers, $header;
288 if ($self->{custom_headers}) {
289 $header_rows = $self->{custom_headers};
291 $header_rows = [ \@column_headers ];
294 my ($outer_idx, $inner_idx) = (0, 0);
298 foreach my $row_set (@{ $self->{data} }) {
299 if ('HASH' eq ref $row_set) {
300 if ($row_set->{type} eq 'separator') {
301 if (! scalar @rows) {
302 $next_border_top = 1;
304 $rows[-1]->{BORDER_BOTTOM} = 1;
312 'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
313 'NUM_COLUMNS' => scalar @visible_columns,
314 'BORDER_TOP' => $next_border_top,
315 'data' => $row_set->{data},
318 push @rows, $row_data;
320 $next_border_top = 0;
327 foreach my $row (@{ $row_set }) {
330 my $output_columns = [ ];
332 foreach my $col_name (@visible_columns) {
338 my $col = $row->{$col_name} || { data => [] };
339 $col->{CELL_ROWS} = [ ];
340 foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
341 push @{ $col->{CELL_ROWS} }, {
342 'data' => $self->html_format($col->{data}->[$i]),
343 'link' => $col->{link}->[$i],
347 # Force at least a to be displayed so that browsers
348 # will format the table cell (e.g. borders etc).
349 if (!scalar @{ $col->{CELL_ROWS} }) {
350 push @{ $col->{CELL_ROWS} }, { 'data' => ' ' };
351 } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
352 $col->{CELL_ROWS}->[0]->{data} = ' ';
355 push @{ $output_columns }, $col;
356 $skip_next = $col->{colspan} ? $col->{colspan} - 1 : 0;
360 'COLUMNS' => $output_columns,
361 'outer_idx' => $outer_idx,
362 'outer_idx_odd' => $outer_idx % 2,
363 'inner_idx' => $inner_idx,
364 'BORDER_TOP' => $next_border_top,
367 push @rows, $row_data;
369 $next_border_top = 0;
373 my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} });
375 my $allow_pdf_export = $opts->{allow_pdf_export};
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},
393 'CONTROLLER_DISPATCH' => $opts->{controller_class},
399 sub generate_html_content {
401 my $variables = $self->prepare_html_content();
403 return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
409 return $_[0] * 72 / 2.54;
412 sub generate_pdf_content {
419 my $variables = $self->prepare_html_content();
420 my $form = $self->{form};
421 my $myconfig = $self->{myconfig};
423 my $opts = $self->{options};
424 my $pdfopts = $opts->{pdf_export};
426 my (@data, @column_props, @cell_props);
428 my ($data_row, $cell_props_row);
429 my @visible_columns = $self->get_visible_columns('PDF');
430 my $num_columns = scalar @visible_columns;
431 my $num_header_rows = 1;
433 my $font_encoding = $::lx_office_conf{system}->{dbcharset} || 'ISO-8859-15';
435 foreach my $name (@visible_columns) {
436 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
439 if (!$self->{custom_headers}) {
441 $cell_props_row = [];
442 push @data, $data_row;
443 push @cell_props, $cell_props_row;
445 foreach my $name (@visible_columns) {
446 my $column = $self->{columns}->{$name};
448 push @{ $data_row }, $column->{text};
449 push @{ $cell_props_row }, {};
453 $num_header_rows = scalar @{ $self->{custom_headers} };
455 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
457 $cell_props_row = [];
458 push @data, $data_row;
459 push @cell_props, $cell_props_row;
461 foreach my $custom_header_col (@{ $custom_header_row }) {
462 push @{ $data_row }, $custom_header_col->{text};
464 my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
465 if ($num_output > 1) {
466 push @{ $data_row }, ('') x ($num_output - 1);
467 push @{ $cell_props_row }, { 'colspan' => $num_output };
468 push @{ $cell_props_row }, ({ }) x ($num_output - 1);
471 push @{ $cell_props_row }, {};
477 foreach my $row_set (@{ $self->{data} }) {
478 if ('HASH' eq ref $row_set) {
479 if ($row_set->{type} eq 'colspan_data') {
480 push @data, [ $row_set->{data} ];
482 $cell_props_row = [];
483 push @cell_props, $cell_props_row;
485 foreach (0 .. $num_columns - 1) {
486 push @{ $cell_props_row }, { 'background_color' => '#666666',
487 'font_color' => '#ffffff',
488 'colspan' => $_ == 0 ? -1 : undef, };
494 foreach my $row (@{ $row_set }) {
496 $cell_props_row = [];
498 push @data, $data_row;
499 push @cell_props, $cell_props_row;
502 foreach my $col_name (@visible_columns) {
503 my $col = $row->{$col_name};
504 push @{ $data_row }, join("\n", @{ $col->{data} || [] });
506 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
508 my $cell_props = { };
509 push @{ $cell_props_row }, $cell_props;
511 if ($col->{colspan} && $col->{colspan} > 1) {
512 $cell_props->{colspan} = $col->{colspan};
520 foreach my $i (0 .. scalar(@data) - 1) {
521 my $aref = $data[$i];
522 my $num_columns_here = scalar @{ $aref };
524 if ($num_columns_here < $num_columns) {
525 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
526 } elsif ($num_columns_here > $num_columns) {
527 splice @{ $aref }, $num_columns;
532 'a3' => [ 842, 1190 ],
533 'a4' => [ 595, 842 ],
534 'a5' => [ 420, 595 ],
535 'letter' => [ 612, 792 ],
536 'legal' => [ 612, 1008 ],
539 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
541 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
542 my ($paper_width, $paper_height);
544 if (lc $pdfopts->{orientation} eq 'landscape') {
545 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
547 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
550 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
551 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
552 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
553 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
555 my $table = PDF::Table->new();
556 my $pdf = PDF::API2->new();
557 my $page = $pdf->page();
559 $pdf->mediabox($paper_width, $paper_height);
561 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
562 '-encoding' => $font_encoding);
563 my $font_size = $pdfopts->{font_size} || 7;
564 my $title_font_size = $font_size + 1;
566 my $font_height = $font_size + 2 * $padding;
567 my $title_font_height = $font_size + 2 * $padding;
569 my $header_height = $opts->{title} ? 2 * $title_font_height : undef;
570 my $footer_height = $pdfopts->{number} ? 2 * $font_height : undef;
572 my $top_text_height = 0;
574 if ($self->{options}->{top_info_text}) {
575 my $top_text = $self->{options}->{top_info_text};
576 $top_text =~ s/\r//g;
577 $top_text =~ s/\n+$//;
579 my @lines = split m/\n/, $top_text;
580 $top_text_height = $font_height * scalar @lines;
582 foreach my $line_no (0 .. scalar(@lines) - 1) {
583 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
584 my $text_obj = $page->text();
586 $text_obj->font($font, $font_size);
587 $text_obj->translate($margin_left, $y_pos);
588 $text_obj->text($lines[$line_no]);
596 'w' => $paper_width - $margin_left - $margin_right,
597 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
598 'next_y' => $paper_height - $margin_top - $header_height,
599 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
600 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
602 'background_color_odd' => '#ffffff',
603 'background_color_even' => '#eeeeee',
605 'font_size' => $font_size,
606 'font_color' => '#000000',
607 'num_header_rows' => $num_header_rows,
609 'bg_color' => '#ffffff',
611 'font_color' => '#000000',
613 'column_props' => \@column_props,
614 'cell_props' => \@cell_props,
615 'max_word_length' => 60,
619 foreach my $page_num (1..$pdf->pages()) {
620 my $curpage = $pdf->openpage($page_num);
622 if ($pdfopts->{number}) {
623 my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
624 my $text_obj = $curpage->text();
626 $text_obj->font($font, $font_size);
627 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
628 $text_obj->text($label);
631 if ($opts->{title}) {
632 my $title = $opts->{title};
633 my $text_obj = $curpage->text();
635 $text_obj->font($font, $title_font_size);
636 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
637 $paper_height - $margin_top);
638 $text_obj->text($title, '-underline' => 1);
642 my $content = $pdf->stringify();
645 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
646 $form->{printer_id} = $pdfopts->{printer_id};
647 $form->get_printer_code($myconfig);
648 $printer_command = $form->{printer_command};
651 if ($printer_command) {
652 $self->_print_content('printer_command' => $printer_command,
653 'content' => $content,
654 'copies' => $pdfopts->{copies});
655 $form->{report_generator_printed} = 1;
658 my $filename = $self->get_attachment_basename();
660 print qq|content-type: application/pdf\n|;
661 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
663 $::locale->with_raw_io(\*STDOUT, sub {
669 sub verify_paper_size {
671 my $requested_paper_size = lc shift;
672 my $default_paper_size = shift;
674 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
676 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
683 foreach my $i (1 .. max $params{copies}, 1) {
684 my $printer = IO::File->new("| $params{printer_command}");
685 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
686 $printer->print($params{content});
691 sub _handle_quoting_and_encoding {
692 my ($self, $text, $do_unquote) = @_;
694 $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
695 $text = Encode::encode('UTF-8', $text) if $::locale->is_utf8;
700 sub generate_csv_content {
702 my $stdout = ($::dispatcher->get_standard_filehandles)[1];
704 # Text::CSV_XS seems to downgrade to bytes already (see
705 # SL/FCGIFixes.pm). Therefore don't let FCGI do that again.
706 $::locale->with_raw_io($stdout, sub { $self->_generate_csv_content($stdout) });
709 sub _generate_csv_content {
710 my ($self, $stdout) = @_;
712 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
713 my %valid_escape_chars = ('"' => 1, "'" => 1);
714 my %valid_quote_chars = ('"' => 1, "'" => 1);
716 my $opts = $self->{options}->{csv_export};
717 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
718 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
719 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
720 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
722 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
724 my $csv = Text::CSV_XS->new({ 'binary' => 1,
725 'sep_char' => $sep_char,
726 'escape_char' => $escape_char,
727 'quote_char' => $quote_char,
730 my @visible_columns = $self->get_visible_columns('CSV');
732 if ($opts->{headers}) {
733 if (!$self->{custom_headers}) {
734 $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @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->_handle_quoting_and_encoding($col->{text}, 1)) 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 = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
762 $skip_next = $num_output - 1;
764 push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} });
765 push @data, ('') x $skip_next if ($skip_next);
768 $csv->print($stdout, \@data);
773 sub check_for_pdf_api {
774 return eval { require PDF::API2; 1; } ? 1 : 0;
783 SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
787 my $report = SL::ReportGenerator->new(\%myconfig, $form);
788 $report->set_options(%options); # optional
789 $report->set_columns(%column_defs);
790 $report->set_sort_indicator($column, $direction); # optional
791 $report->add_data($row1, $row2, @more_rows);
792 $report->generate_with_headers();
794 This creates a report object, sets a few columns, adds some data and generates a standard report.
795 Sorting of columns will be alphabetic, and options will be set to their defaults.
796 The report will be printed including table headers, html headers and http headers.
800 Imagine the following scenario:
801 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
802 Then there may be more than one line. You add a loop in the template.
803 Then there are some options made by the user, such as hidden columns. You add more to the template.
804 Then it lacks usability. You want it to be able to sort the data. You add code for that.
805 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
807 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in Lx-Office.
808 It's purpose is to manage all those formating, culling, sorting, and templating.
809 Which makes it almost as complicated to use as doing the work for yourself.
815 =item new \%myconfig,$form,%options
817 Creates a new ReportGenerator object, sets all given options, and returns it.
819 =item set_columns %columns
821 Sets the columns available to this report.
823 =item set_column_order @columns
825 Sets the order of columns. Any columns not present here are appended in alphabetic order.
827 =item set_sort_indicator $column,$direction
829 Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
830 Note that this is only for displaying. The data has to be presented already sorted.
832 =item add_data \@data
834 =item add_data \%data
836 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.
837 Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
838 ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
842 Adds a separator line to the report.
844 =item add_control \%data
846 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
847 Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
848 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
852 Deletes all data filled into the report, but keeps options set.
854 =item set_options %options
856 Sets options. For an incomplete list of options, see section configuration.
858 =item set_options_from_form
860 Tries to import options from the $form object given at creation
862 =item set_export_options $next_sub,@variable_list
864 Sets next_sub and additional variables needed for export.
866 =item get_attachment_basename
868 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
870 =item generate_with_headers
872 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
873 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
875 =item get_visible_columns $format
877 Returns a list of columns that will be visible in the report after considering all options or match the given format.
879 =item html_format $value
881 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
883 =item prepare_html_content $column,$name,@column_headers
885 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
886 Should not be called extrenally, since all render and generate functions invoke it anyway.
888 =item generate_html_content
890 The html generation function. Is invoked by generate_with_headers.
892 =item generate_pdf_content
894 The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
896 =item generate_csv_content
898 The CSV generation function. Uses XS_CSV to parse the information into csv.
904 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.
906 =head2 General Options
910 =item std_column_visibility
912 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
916 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
918 =item allow_pdf_export
920 Used to determine if a button for PDF export should be displayed. Default is yes.
922 =item allow_csv_export
924 Used to determine if a button for CSV export should be displayed. Default is yes.
928 The template to be used for HTML reports. Default is 'report_generator/html_report'.
930 =item controller_class
932 If this is used from a C<SL::Controller::Base> based controller class, pass the
933 class name here and make sure C<SL::Controller::Helper::ReportGenerator> is
934 used in the controller. That way the exports stay functional.
944 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
946 =item orientation (landscape)
948 Landscape or portrait. Default is landscape.
952 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
956 Default is 7. This option only affects the rendering with PDF::API2.
966 The paper margins in cm. They all default to 1.5.
970 Set to a true value if the pages should be numbered. Default is 1.
974 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
992 Character to enclose entries. Default is double quote (").
996 Character to separate entries. Default is semicolon (;).
1000 Character to escape the quote_char. Default is double quote (").
1004 End of line style. Default is Unix.
1008 Include headers? Default is yes.
1016 =head1 MODULE AUTHORS
1018 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
1020 L<http://linet-services.de>