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 link_class)) {
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 {
223 my ($self, %params) = @_;
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});
234 $form->header(no_layout => $params{no_layout});
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 'raw_header_data' => $column->{raw_header_data},
291 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
292 'sort_indicator_direction' => $opts->{sort_indicator_direction},
295 push @column_headers, $header;
299 if ($self->{custom_headers}) {
300 $header_rows = $self->{custom_headers};
302 $header_rows = [ \@column_headers ];
305 my ($outer_idx, $inner_idx) = (0, 0);
309 foreach my $row_set (@{ $self->{data} }) {
310 if ('HASH' eq ref $row_set) {
311 if ($row_set->{type} eq 'separator') {
312 if (! scalar @rows) {
313 $next_border_top = 1;
315 $rows[-1]->{BORDER_BOTTOM} = 1;
323 'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
324 'NUM_COLUMNS' => scalar @visible_columns,
325 'BORDER_TOP' => $next_border_top,
326 'data' => $row_set->{data},
329 push @rows, $row_data;
331 $next_border_top = 0;
338 foreach my $row (@{ $row_set }) {
341 my $output_columns = [ ];
343 foreach my $col_name (@visible_columns) {
349 my $col = $row->{$col_name} || { data => [] };
350 $col->{CELL_ROWS} = [ ];
351 foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
352 push @{ $col->{CELL_ROWS} }, {
353 'data' => '' . $self->html_format($col->{data}->[$i]),
354 'link' => $col->{link}->[$i],
355 link_class => $col->{link_class}->[$i],
359 # Force at least a to be displayed so that browsers
360 # will format the table cell (e.g. borders etc).
361 if (!scalar @{ $col->{CELL_ROWS} }) {
362 push @{ $col->{CELL_ROWS} }, { 'data' => ' ' };
363 } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
364 $col->{CELL_ROWS}->[0]->{data} = ' ';
367 push @{ $output_columns }, $col;
368 $skip_next = $col->{colspan} ? $col->{colspan} - 1 : 0;
372 'COLUMNS' => $output_columns,
373 'outer_idx' => $outer_idx,
374 'outer_idx_odd' => $outer_idx % 2,
375 'inner_idx' => $inner_idx,
376 'BORDER_TOP' => $next_border_top,
379 push @rows, $row_data;
381 $next_border_top = 0;
385 my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} });
387 my $allow_pdf_export = $opts->{allow_pdf_export};
390 'TITLE' => $opts->{title},
391 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
392 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
393 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
394 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
395 'ALLOW_PDF_EXPORT' => $allow_pdf_export,
396 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export},
397 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
398 'HEADER_ROWS' => $header_rows,
399 'NUM_COLUMNS' => scalar @column_headers,
401 'EXPORT_VARIABLES' => \@export_variables,
402 'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
403 'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
404 'DATA_PRESENT' => $self->{data_present},
405 'CONTROLLER_DISPATCH' => $opts->{controller_class},
406 'TABLE_CLASS' => $opts->{table_class},
412 sub generate_html_content {
414 my $variables = $self->prepare_html_content();
416 my $stuff = $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
423 return $_[0] * 72 / 2.54;
426 sub generate_pdf_content {
433 my $variables = $self->prepare_html_content();
434 my $form = $self->{form};
435 my $myconfig = $self->{myconfig};
437 my $opts = $self->{options};
438 my $pdfopts = $opts->{pdf_export};
440 my (@data, @column_props, @cell_props);
442 my ($data_row, $cell_props_row);
443 my @visible_columns = $self->get_visible_columns('PDF');
444 my $num_columns = scalar @visible_columns;
445 my $num_header_rows = 1;
447 my $font_encoding = 'UTF-8';
449 foreach my $name (@visible_columns) {
450 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
453 if (!$self->{custom_headers}) {
455 $cell_props_row = [];
456 push @data, $data_row;
457 push @cell_props, $cell_props_row;
459 foreach my $name (@visible_columns) {
460 my $column = $self->{columns}->{$name};
462 push @{ $data_row }, $column->{text};
463 push @{ $cell_props_row }, {};
467 $num_header_rows = scalar @{ $self->{custom_headers} };
469 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
471 $cell_props_row = [];
472 push @data, $data_row;
473 push @cell_props, $cell_props_row;
475 foreach my $custom_header_col (@{ $custom_header_row }) {
476 push @{ $data_row }, $custom_header_col->{text};
478 my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
479 if ($num_output > 1) {
480 push @{ $data_row }, ('') x ($num_output - 1);
481 push @{ $cell_props_row }, { 'colspan' => $num_output };
482 push @{ $cell_props_row }, ({ }) x ($num_output - 1);
485 push @{ $cell_props_row }, {};
491 foreach my $row_set (@{ $self->{data} }) {
492 if ('HASH' eq ref $row_set) {
493 if ($row_set->{type} eq 'colspan_data') {
494 push @data, [ $row_set->{data} ];
496 $cell_props_row = [];
497 push @cell_props, $cell_props_row;
499 foreach (0 .. $num_columns - 1) {
500 push @{ $cell_props_row }, { 'background_color' => '#666666',
501 'font_color' => '#ffffff',
502 'colspan' => $_ == 0 ? -1 : undef, };
508 foreach my $row (@{ $row_set }) {
510 $cell_props_row = [];
512 push @data, $data_row;
513 push @cell_props, $cell_props_row;
516 foreach my $col_name (@visible_columns) {
517 my $col = $row->{$col_name};
518 push @{ $data_row }, join("\n", @{ $col->{data} || [] });
520 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
522 my $cell_props = { };
523 push @{ $cell_props_row }, $cell_props;
525 if ($col->{colspan} && $col->{colspan} > 1) {
526 $cell_props->{colspan} = $col->{colspan};
534 foreach my $i (0 .. scalar(@data) - 1) {
535 my $aref = $data[$i];
536 my $num_columns_here = scalar @{ $aref };
538 if ($num_columns_here < $num_columns) {
539 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
540 } elsif ($num_columns_here > $num_columns) {
541 splice @{ $aref }, $num_columns;
546 'a3' => [ 842, 1190 ],
547 'a4' => [ 595, 842 ],
548 'a5' => [ 420, 595 ],
549 'letter' => [ 612, 792 ],
550 'legal' => [ 612, 1008 ],
553 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
555 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
556 my ($paper_width, $paper_height);
558 if (lc $pdfopts->{orientation} eq 'landscape') {
559 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
561 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
564 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
565 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
566 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
567 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
569 my $table = PDF::Table->new();
570 my $pdf = PDF::API2->new();
571 my $page = $pdf->page();
573 $pdf->mediabox($paper_width, $paper_height);
575 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
576 '-encoding' => $font_encoding);
577 my $font_size = $pdfopts->{font_size} || 7;
578 my $title_font_size = $font_size + 1;
580 my $font_height = $font_size + 2 * $padding;
581 my $title_font_height = $font_size + 2 * $padding;
583 my $header_height = $opts->{title} ? 2 * $title_font_height : undef;
584 my $footer_height = $pdfopts->{number} ? 2 * $font_height : undef;
586 my $top_text_height = 0;
588 if ($self->{options}->{top_info_text}) {
589 my $top_text = $self->{options}->{top_info_text};
590 $top_text =~ s/\r//g;
591 $top_text =~ s/\n+$//;
593 my @lines = split m/\n/, $top_text;
594 $top_text_height = $font_height * scalar @lines;
596 foreach my $line_no (0 .. scalar(@lines) - 1) {
597 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
598 my $text_obj = $page->text();
600 $text_obj->font($font, $font_size);
601 $text_obj->translate($margin_left, $y_pos);
602 $text_obj->text($lines[$line_no]);
610 'w' => $paper_width - $margin_left - $margin_right,
611 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
612 'next_y' => $paper_height - $margin_top - $header_height,
613 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
614 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
616 'background_color_odd' => '#ffffff',
617 'background_color_even' => '#eeeeee',
619 'font_size' => $font_size,
620 'font_color' => '#000000',
621 'num_header_rows' => $num_header_rows,
623 'bg_color' => '#ffffff',
625 'font_color' => '#000000',
627 'column_props' => \@column_props,
628 'cell_props' => \@cell_props,
629 'max_word_length' => 60,
633 foreach my $page_num (1..$pdf->pages()) {
634 my $curpage = $pdf->openpage($page_num);
636 if ($pdfopts->{number}) {
637 my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
638 my $text_obj = $curpage->text();
640 $text_obj->font($font, $font_size);
641 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
642 $text_obj->text($label);
645 if ($opts->{title}) {
646 my $title = $opts->{title};
647 my $text_obj = $curpage->text();
649 $text_obj->font($font, $title_font_size);
650 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
651 $paper_height - $margin_top);
652 $text_obj->text($title, '-underline' => 1);
656 my $content = $pdf->stringify();
659 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
660 $form->{printer_id} = $pdfopts->{printer_id};
661 $form->get_printer_code($myconfig);
662 $printer_command = $form->{printer_command};
665 if ($printer_command) {
666 $self->_print_content('printer_command' => $printer_command,
667 'content' => $content,
668 'copies' => $pdfopts->{copies});
669 $form->{report_generator_printed} = 1;
672 my $filename = $self->get_attachment_basename();
674 print qq|content-type: application/pdf\n|;
675 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
677 $::locale->with_raw_io(\*STDOUT, sub {
683 sub verify_paper_size {
685 my $requested_paper_size = lc shift;
686 my $default_paper_size = shift;
688 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
690 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
697 foreach my $i (1 .. max $params{copies}, 1) {
698 my $printer = IO::File->new("| $params{printer_command}");
699 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
700 $printer->print($params{content});
705 sub _handle_quoting_and_encoding {
706 my ($self, $text, $do_unquote) = @_;
708 $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
709 $text = Encode::encode('UTF-8', $text);
714 sub generate_csv_content {
716 my $stdout = ($::dispatcher->get_standard_filehandles)[1];
718 # Text::CSV_XS seems to downgrade to bytes already (see
719 # SL/FCGIFixes.pm). Therefore don't let FCGI do that again.
720 $::locale->with_raw_io($stdout, sub { $self->_generate_csv_content($stdout) });
723 sub _generate_csv_content {
724 my ($self, $stdout) = @_;
726 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
727 my %valid_escape_chars = ('"' => 1, "'" => 1);
728 my %valid_quote_chars = ('"' => 1, "'" => 1);
730 my $opts = $self->{options}->{csv_export};
731 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
732 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
733 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
734 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
736 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
738 my $csv = Text::CSV_XS->new({ 'binary' => 1,
739 'sep_char' => $sep_char,
740 'escape_char' => $escape_char,
741 'quote_char' => $quote_char,
744 my @visible_columns = $self->get_visible_columns('CSV');
746 if ($opts->{headers}) {
747 if (!$self->{custom_headers}) {
748 $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @visible_columns ]);
751 foreach my $row (@{ $self->{custom_headers} }) {
754 foreach my $col (@{ $row }) {
755 my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
756 push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1)) x $num_output;
759 $csv->print($stdout, $fields);
764 foreach my $row_set (@{ $self->{data} }) {
765 next if ('ARRAY' ne ref $row_set);
766 foreach my $row (@{ $row_set }) {
769 foreach my $col (@visible_columns) {
775 my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
776 $skip_next = $num_output - 1;
778 push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} });
779 push @data, ('') x $skip_next if ($skip_next);
782 $csv->print($stdout, \@data);
787 sub check_for_pdf_api {
788 return eval { require PDF::API2; 1; } ? 1 : 0;
797 SL::ReportGenerator.pm: the kivitendo way of getting data in shape
801 my $report = SL::ReportGenerator->new(\%myconfig, $form);
802 $report->set_options(%options); # optional
803 $report->set_columns(%column_defs);
804 $report->set_sort_indicator($column, $direction); # optional
805 $report->add_data($row1, $row2, @more_rows);
806 $report->generate_with_headers();
808 This creates a report object, sets a few columns, adds some data and generates a standard report.
809 Sorting of columns will be alphabetic, and options will be set to their defaults.
810 The report will be printed including table headers, html headers and http headers.
814 Imagine the following scenario:
815 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
816 Then there may be more than one line. You add a loop in the template.
817 Then there are some options made by the user, such as hidden columns. You add more to the template.
818 Then it lacks usability. You want it to be able to sort the data. You add code for that.
819 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
821 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in kivitendo.
822 It's purpose is to manage all those formating, culling, sorting, and templating.
823 Which makes it almost as complicated to use as doing the work by yourself.
829 =item new \%myconfig,$form,%options
831 Creates a new ReportGenerator object, sets all given options, and returns it.
833 =item set_columns %columns
835 Sets the columns available to this report.
837 =item set_column_order @columns
839 Sets the order of columns. Any columns not present here are appended in alphabetic order.
841 =item set_sort_indicator $column,$direction
843 Sets sorting of the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
844 Note that this is only for displaying. The data has to have already been sorted when it was added.
846 =item add_data \@data
848 =item add_data \%data
850 Adds data to the report. A given hash_ref is interpreted as a single line of
851 data, every array_ref as a collection of lines. Every line will be expected to
852 be in a key => value format. Note that the rows have to already have been
855 The ReportGenerator is only able to display pre-sorted data and to indicate by
856 which column and in which direction the data has been sorted via visual clues
857 in the column headers. It also provides links to invert the sort direction.
861 Adds a separator line to the report.
863 =item add_control \%data
865 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
866 Every control element needs to set IS_CONTROL_DATA, in order to be recognized by the template.
867 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
871 Deletes all data added to the report, but keeps options set.
873 =item set_options %options
875 Sets options. For an incomplete list of options, see section configuration.
877 =item set_options_from_form
879 Tries to import options from the $form object given at creation
881 =item set_export_options $next_sub,@variable_list
883 Sets next_sub and additional variables needed for export.
885 =item get_attachment_basename
887 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
889 =item generate_with_headers
891 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
892 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
894 =item get_visible_columns $format
896 Returns a list of columns that will be visible in the report after considering all options or match the given format.
898 =item html_format $value
900 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
902 =item prepare_html_content $column,$name,@column_headers
904 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
905 Should not be called externally, since all render and generate functions invoke it anyway.
907 =item generate_html_content
909 The html generation function. Is invoked by generate_with_headers.
911 =item generate_pdf_content
913 The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
915 =item generate_csv_content
917 The CSV generation function. Uses XS_CSV to parse the information into csv.
923 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.
925 =head2 General Options
929 =item std_column_visibility
931 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
935 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
937 =item allow_pdf_export
939 Used to determine if a button for PDF export should be displayed. Default is yes.
941 =item allow_csv_export
943 Used to determine if a button for CSV export should be displayed. Default is yes.
947 The template to be used for HTML reports. Default is 'report_generator/html_report'.
949 =item controller_class
951 If this is used from a C<SL::Controller::Base> based controller class, pass the
952 class name here and make sure C<SL::Controller::Helper::ReportGenerator> is
953 used in the controller. That way the exports stay functional.
963 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
965 =item orientation (landscape)
967 Landscape or portrait. Default is landscape.
971 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
975 Default is 7. This option only affects the rendering with PDF::API2.
985 The paper margins in cm. They all default to 1.5.
989 Set to a true value if the pages should be numbered. Default is 1.
993 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
1011 Character to enclose entries. Default is double quote (").
1015 Character to separate entries. Default is semicolon (;).
1019 Character to escape the quote_char. Default is double quote (").
1023 End of line style. Default is Unix.
1027 Include headers? Default is yes.
1035 =head1 MODULE AUTHORS
1037 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
1039 L<http://linet-services.de>