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 if( $::form->{report_generator_csv_options_for_import} ) {
77 foreach my $key (keys %{ $self->{columns} }) {
78 $self->{columns}{$key}{text} = $key;
82 $self->set_column_order(sort keys %{ $self->{columns} });
85 sub set_column_order {
88 $self->{column_order} = [ grep { !$seen{$_}++ } @_, sort keys %{ $self->{columns} } ];
91 sub set_sort_indicator {
94 $self->{options}->{sort_indicator_column} = shift;
95 $self->{options}->{sort_indicator_direction} = shift;
103 while (my $arg = shift) {
106 if ('ARRAY' eq ref $arg) {
109 } elsif ('HASH' eq ref $arg) {
113 $self->{form}->error('Incorrect usage -- expecting hash or array ref');
116 my @columns_with_default_alignment = grep { defined $self->{columns}->{$_}->{align} } keys %{ $self->{columns} };
118 foreach my $row (@{ $row_set }) {
119 foreach my $column (@columns_with_default_alignment) {
120 $row->{$column} ||= { };
121 $row->{$column}->{align} = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
124 foreach my $field (qw(data link)) {
125 map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
129 push @{ $self->{data} }, $row_set;
130 $last_row_set = $row_set;
132 $self->{data_present} = 1;
135 return $last_row_set;
141 push @{ $self->{data} }, { 'type' => 'separator' };
148 push @{ $self->{data} }, $data;
155 $self->{data_present} = 0;
162 while (my ($key, $value) = each %options) {
163 if ($key eq 'pdf_export') {
164 map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
166 $self->{options}->{$key} = $value;
171 sub set_options_from_form {
174 my $form = $self->{form};
175 my $myconfig = $self->{myconfig};
177 foreach my $key (qw(output_format)) {
178 my $full_key = "report_generator_${key}";
179 $self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
182 foreach my $format (qw(pdf csv)) {
183 my $opts = $self->{options}->{"${format}_export"};
184 foreach my $key (keys %{ $opts }) {
185 my $full_key = "report_generator_${format}_options_${key}";
186 $opts->{$key} = $key =~ /^margin/ ? $form->parse_amount($myconfig, $form->{$full_key}) : $form->{$full_key};
191 sub set_export_options {
196 'variable_list' => [ @_ ],
200 sub set_custom_headers {
204 $self->{custom_headers} = [ @_ ];
206 delete $self->{custom_headers};
210 sub get_attachment_basename {
212 my $filename = $self->{options}->{attachment_basename} || 'report';
214 # FIXME: this is bonkers. add a real sluggify method somewhere or import one.
215 $filename =~ s|.*\\||;
216 $filename =~ s|.*/||;
217 $filename =~ s| |_|g;
222 sub generate_with_headers {
224 my $format = lc $self->{options}->{output_format};
225 my $form = $self->{form};
227 if (!$self->{columns}) {
228 $form->error('Incorrect usage -- no columns specified');
231 if ($format eq 'html') {
232 my $title = $form->{title};
233 $form->{title} = $self->{title} if ($self->{title});
235 $form->{title} = $title;
237 print $self->generate_html_content();
239 } elsif ($format eq 'csv') {
240 # FIXME: don't do mini http in here
241 my $filename = $self->get_attachment_basename();
242 print qq|content-type: text/csv\n|;
243 print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
244 $::locale->with_raw_io(\*STDOUT, sub {
245 $self->generate_csv_content();
248 } elsif ($format eq 'pdf') {
249 $self->generate_pdf_content();
252 $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
256 sub get_visible_columns {
260 return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /\Q${format}\E/i)) } @{ $self->{column_order} };
267 $value = $main::locale->quote_special_chars('HTML', $value);
269 $value =~ s/\n/<br>/g;
274 sub prepare_html_content {
277 my ($column, $name, @column_headers);
279 my $opts = $self->{options};
280 my @visible_columns = $self->get_visible_columns('HTML');
282 foreach $name (@visible_columns) {
283 $column = $self->{columns}->{$name};
287 'align' => $column->{align},
288 'link' => $column->{link},
289 'text' => $column->{text},
290 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
291 'sort_indicator_direction' => $opts->{sort_indicator_direction},
294 push @column_headers, $header;
298 if ($self->{custom_headers}) {
299 $header_rows = $self->{custom_headers};
301 $header_rows = [ \@column_headers ];
304 my ($outer_idx, $inner_idx) = (0, 0);
308 foreach my $row_set (@{ $self->{data} }) {
309 if ('HASH' eq ref $row_set) {
310 if ($row_set->{type} eq 'separator') {
311 if (! scalar @rows) {
312 $next_border_top = 1;
314 $rows[-1]->{BORDER_BOTTOM} = 1;
322 'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
323 'NUM_COLUMNS' => scalar @visible_columns,
324 'BORDER_TOP' => $next_border_top,
325 'data' => $row_set->{data},
328 push @rows, $row_data;
330 $next_border_top = 0;
337 foreach my $row (@{ $row_set }) {
340 my $output_columns = [ ];
342 foreach my $col_name (@visible_columns) {
348 my $col = $row->{$col_name} || { data => [] };
349 $col->{CELL_ROWS} = [ ];
350 foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
351 push @{ $col->{CELL_ROWS} }, {
352 'data' => $self->html_format($col->{data}->[$i]),
353 'link' => $col->{link}->[$i],
357 # Force at least a to be displayed so that browsers
358 # will format the table cell (e.g. borders etc).
359 if (!scalar @{ $col->{CELL_ROWS} }) {
360 push @{ $col->{CELL_ROWS} }, { 'data' => ' ' };
361 } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
362 $col->{CELL_ROWS}->[0]->{data} = ' ';
365 push @{ $output_columns }, $col;
366 $skip_next = $col->{colspan} ? $col->{colspan} - 1 : 0;
370 'COLUMNS' => $output_columns,
371 'outer_idx' => $outer_idx,
372 'outer_idx_odd' => $outer_idx % 2,
373 'inner_idx' => $inner_idx,
374 'BORDER_TOP' => $next_border_top,
377 push @rows, $row_data;
379 $next_border_top = 0;
383 my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} });
385 my $allow_pdf_export = $opts->{allow_pdf_export};
388 'TITLE' => $opts->{title},
389 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
390 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
391 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
392 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
393 'ALLOW_PDF_EXPORT' => $allow_pdf_export,
394 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export},
395 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
396 'HEADER_ROWS' => $header_rows,
397 'NUM_COLUMNS' => scalar @column_headers,
399 'EXPORT_VARIABLES' => \@export_variables,
400 'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
401 'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
402 'DATA_PRESENT' => $self->{data_present},
403 'CONTROLLER_DISPATCH' => $opts->{controller_class},
409 sub generate_html_content {
411 my $variables = $self->prepare_html_content();
413 return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
419 return $_[0] * 72 / 2.54;
422 sub generate_pdf_content {
429 my $variables = $self->prepare_html_content();
430 my $form = $self->{form};
431 my $myconfig = $self->{myconfig};
433 my $opts = $self->{options};
434 my $pdfopts = $opts->{pdf_export};
436 my (@data, @column_props, @cell_props);
438 my ($data_row, $cell_props_row);
439 my @visible_columns = $self->get_visible_columns('PDF');
440 my $num_columns = scalar @visible_columns;
441 my $num_header_rows = 1;
443 my $font_encoding = $::lx_office_conf{system}->{dbcharset} || 'ISO-8859-15';
445 foreach my $name (@visible_columns) {
446 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
449 if (!$self->{custom_headers}) {
451 $cell_props_row = [];
452 push @data, $data_row;
453 push @cell_props, $cell_props_row;
455 foreach my $name (@visible_columns) {
456 my $column = $self->{columns}->{$name};
458 push @{ $data_row }, $column->{text};
459 push @{ $cell_props_row }, {};
463 $num_header_rows = scalar @{ $self->{custom_headers} };
465 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
467 $cell_props_row = [];
468 push @data, $data_row;
469 push @cell_props, $cell_props_row;
471 foreach my $custom_header_col (@{ $custom_header_row }) {
472 push @{ $data_row }, $custom_header_col->{text};
474 my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
475 if ($num_output > 1) {
476 push @{ $data_row }, ('') x ($num_output - 1);
477 push @{ $cell_props_row }, { 'colspan' => $num_output };
478 push @{ $cell_props_row }, ({ }) x ($num_output - 1);
481 push @{ $cell_props_row }, {};
487 foreach my $row_set (@{ $self->{data} }) {
488 if ('HASH' eq ref $row_set) {
489 if ($row_set->{type} eq 'colspan_data') {
490 push @data, [ $row_set->{data} ];
492 $cell_props_row = [];
493 push @cell_props, $cell_props_row;
495 foreach (0 .. $num_columns - 1) {
496 push @{ $cell_props_row }, { 'background_color' => '#666666',
497 'font_color' => '#ffffff',
498 'colspan' => $_ == 0 ? -1 : undef, };
504 foreach my $row (@{ $row_set }) {
506 $cell_props_row = [];
508 push @data, $data_row;
509 push @cell_props, $cell_props_row;
512 foreach my $col_name (@visible_columns) {
513 my $col = $row->{$col_name};
514 push @{ $data_row }, join("\n", @{ $col->{data} || [] });
516 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
518 my $cell_props = { };
519 push @{ $cell_props_row }, $cell_props;
521 if ($col->{colspan} && $col->{colspan} > 1) {
522 $cell_props->{colspan} = $col->{colspan};
530 foreach my $i (0 .. scalar(@data) - 1) {
531 my $aref = $data[$i];
532 my $num_columns_here = scalar @{ $aref };
534 if ($num_columns_here < $num_columns) {
535 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
536 } elsif ($num_columns_here > $num_columns) {
537 splice @{ $aref }, $num_columns;
542 'a3' => [ 842, 1190 ],
543 'a4' => [ 595, 842 ],
544 'a5' => [ 420, 595 ],
545 'letter' => [ 612, 792 ],
546 'legal' => [ 612, 1008 ],
549 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
551 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
552 my ($paper_width, $paper_height);
554 if (lc $pdfopts->{orientation} eq 'landscape') {
555 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
557 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
560 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
561 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
562 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
563 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
565 my $table = PDF::Table->new();
566 my $pdf = PDF::API2->new();
567 my $page = $pdf->page();
569 $pdf->mediabox($paper_width, $paper_height);
571 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
572 '-encoding' => $font_encoding);
573 my $font_size = $pdfopts->{font_size} || 7;
574 my $title_font_size = $font_size + 1;
576 my $font_height = $font_size + 2 * $padding;
577 my $title_font_height = $font_size + 2 * $padding;
579 my $header_height = $opts->{title} ? 2 * $title_font_height : undef;
580 my $footer_height = $pdfopts->{number} ? 2 * $font_height : undef;
582 my $top_text_height = 0;
584 if ($self->{options}->{top_info_text}) {
585 my $top_text = $self->{options}->{top_info_text};
586 $top_text =~ s/\r//g;
587 $top_text =~ s/\n+$//;
589 my @lines = split m/\n/, $top_text;
590 $top_text_height = $font_height * scalar @lines;
592 foreach my $line_no (0 .. scalar(@lines) - 1) {
593 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
594 my $text_obj = $page->text();
596 $text_obj->font($font, $font_size);
597 $text_obj->translate($margin_left, $y_pos);
598 $text_obj->text($lines[$line_no]);
606 'w' => $paper_width - $margin_left - $margin_right,
607 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
608 'next_y' => $paper_height - $margin_top - $header_height,
609 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
610 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
612 'background_color_odd' => '#ffffff',
613 'background_color_even' => '#eeeeee',
615 'font_size' => $font_size,
616 'font_color' => '#000000',
617 'num_header_rows' => $num_header_rows,
619 'bg_color' => '#ffffff',
621 'font_color' => '#000000',
623 'column_props' => \@column_props,
624 'cell_props' => \@cell_props,
625 'max_word_length' => 60,
629 foreach my $page_num (1..$pdf->pages()) {
630 my $curpage = $pdf->openpage($page_num);
632 if ($pdfopts->{number}) {
633 my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
634 my $text_obj = $curpage->text();
636 $text_obj->font($font, $font_size);
637 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
638 $text_obj->text($label);
641 if ($opts->{title}) {
642 my $title = $opts->{title};
643 my $text_obj = $curpage->text();
645 $text_obj->font($font, $title_font_size);
646 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
647 $paper_height - $margin_top);
648 $text_obj->text($title, '-underline' => 1);
652 my $content = $pdf->stringify();
655 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
656 $form->{printer_id} = $pdfopts->{printer_id};
657 $form->get_printer_code($myconfig);
658 $printer_command = $form->{printer_command};
661 if ($printer_command) {
662 $self->_print_content('printer_command' => $printer_command,
663 'content' => $content,
664 'copies' => $pdfopts->{copies});
665 $form->{report_generator_printed} = 1;
668 my $filename = $self->get_attachment_basename();
670 print qq|content-type: application/pdf\n|;
671 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
673 $::locale->with_raw_io(\*STDOUT, sub {
679 sub verify_paper_size {
681 my $requested_paper_size = lc shift;
682 my $default_paper_size = shift;
684 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
686 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
693 foreach my $i (1 .. max $params{copies}, 1) {
694 my $printer = IO::File->new("| $params{printer_command}");
695 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
696 $printer->print($params{content});
701 sub _handle_quoting_and_encoding {
702 my ($self, $text, $do_unquote) = @_;
704 $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
705 $text = Encode::encode('UTF-8', $text) if $::locale->is_utf8;
710 sub generate_csv_content {
712 my $stdout = ($::dispatcher->get_standard_filehandles)[1];
714 # Text::CSV_XS seems to downgrade to bytes already (see
715 # SL/FCGIFixes.pm). Therefore don't let FCGI do that again.
716 $::locale->with_raw_io($stdout, sub { $self->_generate_csv_content($stdout) });
719 sub _generate_csv_content {
720 my ($self, $stdout) = @_;
722 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
723 my %valid_escape_chars = ('"' => 1, "'" => 1);
724 my %valid_quote_chars = ('"' => 1, "'" => 1);
726 my $opts = $self->{options}->{csv_export};
727 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
728 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
729 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
730 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
732 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
734 my $csv = Text::CSV_XS->new({ 'binary' => 1,
735 'sep_char' => $sep_char,
736 'escape_char' => $escape_char,
737 'quote_char' => $quote_char,
740 my @visible_columns = $self->get_visible_columns('CSV');
742 if ($opts->{headers}) {
743 if (!$self->{custom_headers}) {
744 $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @visible_columns ]);
747 foreach my $row (@{ $self->{custom_headers} }) {
750 foreach my $col (@{ $row }) {
751 my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
752 push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1)) x $num_output;
755 $csv->print($stdout, $fields);
760 foreach my $row_set (@{ $self->{data} }) {
761 next if ('ARRAY' ne ref $row_set);
762 foreach my $row (@{ $row_set }) {
765 foreach my $col (@visible_columns) {
771 my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
772 $skip_next = $num_output - 1;
774 push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} });
775 push @data, ('') x $skip_next if ($skip_next);
778 $csv->print($stdout, \@data);
783 sub check_for_pdf_api {
784 return eval { require PDF::API2; 1; } ? 1 : 0;
793 SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
797 my $report = SL::ReportGenerator->new(\%myconfig, $form);
798 $report->set_options(%options); # optional
799 $report->set_columns(%column_defs);
800 $report->set_sort_indicator($column, $direction); # optional
801 $report->add_data($row1, $row2, @more_rows);
802 $report->generate_with_headers();
804 This creates a report object, sets a few columns, adds some data and generates a standard report.
805 Sorting of columns will be alphabetic, and options will be set to their defaults.
806 The report will be printed including table headers, html headers and http headers.
810 Imagine the following scenario:
811 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
812 Then there may be more than one line. You add a loop in the template.
813 Then there are some options made by the user, such as hidden columns. You add more to the template.
814 Then it lacks usability. You want it to be able to sort the data. You add code for that.
815 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
817 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in Lx-Office.
818 It's purpose is to manage all those formating, culling, sorting, and templating.
819 Which makes it almost as complicated to use as doing the work for yourself.
825 =item new \%myconfig,$form,%options
827 Creates a new ReportGenerator object, sets all given options, and returns it.
829 =item set_columns %columns
831 Sets the columns available to this report.
833 =item set_column_order @columns
835 Sets the order of columns. Any columns not present here are appended in alphabetic order.
837 =item set_sort_indicator $column,$direction
839 Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
840 Note that this is only for displaying. The data has to be presented already sorted.
842 =item add_data \@data
844 =item add_data \%data
846 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.
847 Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
848 ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
852 Adds a separator line to the report.
854 =item add_control \%data
856 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
857 Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
858 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
862 Deletes all data filled into the report, but keeps options set.
864 =item set_options %options
866 Sets options. For an incomplete list of options, see section configuration.
868 =item set_options_from_form
870 Tries to import options from the $form object given at creation
872 =item set_export_options $next_sub,@variable_list
874 Sets next_sub and additional variables needed for export.
876 =item get_attachment_basename
878 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
880 =item generate_with_headers
882 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
883 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
885 =item get_visible_columns $format
887 Returns a list of columns that will be visible in the report after considering all options or match the given format.
889 =item html_format $value
891 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
893 =item prepare_html_content $column,$name,@column_headers
895 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
896 Should not be called extrenally, since all render and generate functions invoke it anyway.
898 =item generate_html_content
900 The html generation function. Is invoked by generate_with_headers.
902 =item generate_pdf_content
904 The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
906 =item generate_csv_content
908 The CSV generation function. Uses XS_CSV to parse the information into csv.
914 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.
916 =head2 General Options
920 =item std_column_visibility
922 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
926 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
928 =item allow_pdf_export
930 Used to determine if a button for PDF export should be displayed. Default is yes.
932 =item allow_csv_export
934 Used to determine if a button for CSV export should be displayed. Default is yes.
938 The template to be used for HTML reports. Default is 'report_generator/html_report'.
940 =item controller_class
942 If this is used from a C<SL::Controller::Base> based controller class, pass the
943 class name here and make sure C<SL::Controller::Helper::ReportGenerator> is
944 used in the controller. That way the exports stay functional.
954 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
956 =item orientation (landscape)
958 Landscape or portrait. Default is landscape.
962 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
966 Default is 7. This option only affects the rendering with PDF::API2.
976 The paper margins in cm. They all default to 1.5.
980 Set to a true value if the pages should be numbered. Default is 1.
984 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
1002 Character to enclose entries. Default is double quote (").
1006 Character to separate entries. Default is semicolon (;).
1010 Character to escape the quote_char. Default is double quote (").
1014 End of line style. Default is Unix.
1018 Include headers? Default is yes.
1026 =head1 MODULE AUTHORS
1028 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
1030 L<http://linet-services.de>