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 {
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 '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},
404 'TABLE_CLASS' => $opts->{table_class},
410 sub generate_html_content {
412 my $variables = $self->prepare_html_content();
414 my $stuff = $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
421 return $_[0] * 72 / 2.54;
424 sub generate_pdf_content {
431 my $variables = $self->prepare_html_content();
432 my $form = $self->{form};
433 my $myconfig = $self->{myconfig};
435 my $opts = $self->{options};
436 my $pdfopts = $opts->{pdf_export};
438 my (@data, @column_props, @cell_props);
440 my ($data_row, $cell_props_row);
441 my @visible_columns = $self->get_visible_columns('PDF');
442 my $num_columns = scalar @visible_columns;
443 my $num_header_rows = 1;
445 my $font_encoding = 'UTF-8';
447 foreach my $name (@visible_columns) {
448 push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
451 if (!$self->{custom_headers}) {
453 $cell_props_row = [];
454 push @data, $data_row;
455 push @cell_props, $cell_props_row;
457 foreach my $name (@visible_columns) {
458 my $column = $self->{columns}->{$name};
460 push @{ $data_row }, $column->{text};
461 push @{ $cell_props_row }, {};
465 $num_header_rows = scalar @{ $self->{custom_headers} };
467 foreach my $custom_header_row (@{ $self->{custom_headers} }) {
469 $cell_props_row = [];
470 push @data, $data_row;
471 push @cell_props, $cell_props_row;
473 foreach my $custom_header_col (@{ $custom_header_row }) {
474 push @{ $data_row }, $custom_header_col->{text};
476 my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
477 if ($num_output > 1) {
478 push @{ $data_row }, ('') x ($num_output - 1);
479 push @{ $cell_props_row }, { 'colspan' => $num_output };
480 push @{ $cell_props_row }, ({ }) x ($num_output - 1);
483 push @{ $cell_props_row }, {};
489 foreach my $row_set (@{ $self->{data} }) {
490 if ('HASH' eq ref $row_set) {
491 if ($row_set->{type} eq 'colspan_data') {
492 push @data, [ $row_set->{data} ];
494 $cell_props_row = [];
495 push @cell_props, $cell_props_row;
497 foreach (0 .. $num_columns - 1) {
498 push @{ $cell_props_row }, { 'background_color' => '#666666',
499 'font_color' => '#ffffff',
500 'colspan' => $_ == 0 ? -1 : undef, };
506 foreach my $row (@{ $row_set }) {
508 $cell_props_row = [];
510 push @data, $data_row;
511 push @cell_props, $cell_props_row;
514 foreach my $col_name (@visible_columns) {
515 my $col = $row->{$col_name};
516 push @{ $data_row }, join("\n", @{ $col->{data} || [] });
518 $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
520 my $cell_props = { };
521 push @{ $cell_props_row }, $cell_props;
523 if ($col->{colspan} && $col->{colspan} > 1) {
524 $cell_props->{colspan} = $col->{colspan};
532 foreach my $i (0 .. scalar(@data) - 1) {
533 my $aref = $data[$i];
534 my $num_columns_here = scalar @{ $aref };
536 if ($num_columns_here < $num_columns) {
537 push @{ $aref }, ('') x ($num_columns - $num_columns_here);
538 } elsif ($num_columns_here > $num_columns) {
539 splice @{ $aref }, $num_columns;
544 'a3' => [ 842, 1190 ],
545 'a4' => [ 595, 842 ],
546 'a5' => [ 420, 595 ],
547 'letter' => [ 612, 792 ],
548 'legal' => [ 612, 1008 ],
551 my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
553 my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
554 my ($paper_width, $paper_height);
556 if (lc $pdfopts->{orientation} eq 'landscape') {
557 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
559 ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
562 my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
563 my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
564 my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
565 my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
567 my $table = PDF::Table->new();
568 my $pdf = PDF::API2->new();
569 my $page = $pdf->page();
571 $pdf->mediabox($paper_width, $paper_height);
573 my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
574 '-encoding' => $font_encoding);
575 my $font_size = $pdfopts->{font_size} || 7;
576 my $title_font_size = $font_size + 1;
578 my $font_height = $font_size + 2 * $padding;
579 my $title_font_height = $font_size + 2 * $padding;
581 my $header_height = $opts->{title} ? 2 * $title_font_height : undef;
582 my $footer_height = $pdfopts->{number} ? 2 * $font_height : undef;
584 my $top_text_height = 0;
586 if ($self->{options}->{top_info_text}) {
587 my $top_text = $self->{options}->{top_info_text};
588 $top_text =~ s/\r//g;
589 $top_text =~ s/\n+$//;
591 my @lines = split m/\n/, $top_text;
592 $top_text_height = $font_height * scalar @lines;
594 foreach my $line_no (0 .. scalar(@lines) - 1) {
595 my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
596 my $text_obj = $page->text();
598 $text_obj->font($font, $font_size);
599 $text_obj->translate($margin_left, $y_pos);
600 $text_obj->text($lines[$line_no]);
608 'w' => $paper_width - $margin_left - $margin_right,
609 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
610 'next_y' => $paper_height - $margin_top - $header_height,
611 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
612 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
614 'background_color_odd' => '#ffffff',
615 'background_color_even' => '#eeeeee',
617 'font_size' => $font_size,
618 'font_color' => '#000000',
619 'num_header_rows' => $num_header_rows,
621 'bg_color' => '#ffffff',
623 'font_color' => '#000000',
625 'column_props' => \@column_props,
626 'cell_props' => \@cell_props,
627 'max_word_length' => 60,
631 foreach my $page_num (1..$pdf->pages()) {
632 my $curpage = $pdf->openpage($page_num);
634 if ($pdfopts->{number}) {
635 my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
636 my $text_obj = $curpage->text();
638 $text_obj->font($font, $font_size);
639 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
640 $text_obj->text($label);
643 if ($opts->{title}) {
644 my $title = $opts->{title};
645 my $text_obj = $curpage->text();
647 $text_obj->font($font, $title_font_size);
648 $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
649 $paper_height - $margin_top);
650 $text_obj->text($title, '-underline' => 1);
654 my $content = $pdf->stringify();
657 if ($pdfopts->{print} && $pdfopts->{printer_id}) {
658 $form->{printer_id} = $pdfopts->{printer_id};
659 $form->get_printer_code($myconfig);
660 $printer_command = $form->{printer_command};
663 if ($printer_command) {
664 $self->_print_content('printer_command' => $printer_command,
665 'content' => $content,
666 'copies' => $pdfopts->{copies});
667 $form->{report_generator_printed} = 1;
670 my $filename = $self->get_attachment_basename();
672 print qq|content-type: application/pdf\n|;
673 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
675 $::locale->with_raw_io(\*STDOUT, sub {
681 sub verify_paper_size {
683 my $requested_paper_size = lc shift;
684 my $default_paper_size = shift;
686 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
688 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
695 foreach my $i (1 .. max $params{copies}, 1) {
696 my $printer = IO::File->new("| $params{printer_command}");
697 $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
698 $printer->print($params{content});
703 sub _handle_quoting_and_encoding {
704 my ($self, $text, $do_unquote) = @_;
706 $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
707 $text = Encode::encode('UTF-8', $text);
712 sub generate_csv_content {
714 my $stdout = ($::dispatcher->get_standard_filehandles)[1];
716 # Text::CSV_XS seems to downgrade to bytes already (see
717 # SL/FCGIFixes.pm). Therefore don't let FCGI do that again.
718 $::locale->with_raw_io($stdout, sub { $self->_generate_csv_content($stdout) });
721 sub _generate_csv_content {
722 my ($self, $stdout) = @_;
724 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
725 my %valid_escape_chars = ('"' => 1, "'" => 1);
726 my %valid_quote_chars = ('"' => 1, "'" => 1);
728 my $opts = $self->{options}->{csv_export};
729 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
730 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
731 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
732 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
734 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
736 my $csv = Text::CSV_XS->new({ 'binary' => 1,
737 'sep_char' => $sep_char,
738 'escape_char' => $escape_char,
739 'quote_char' => $quote_char,
742 my @visible_columns = $self->get_visible_columns('CSV');
744 if ($opts->{headers}) {
745 if (!$self->{custom_headers}) {
746 $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @visible_columns ]);
749 foreach my $row (@{ $self->{custom_headers} }) {
752 foreach my $col (@{ $row }) {
753 my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
754 push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1)) x $num_output;
757 $csv->print($stdout, $fields);
762 foreach my $row_set (@{ $self->{data} }) {
763 next if ('ARRAY' ne ref $row_set);
764 foreach my $row (@{ $row_set }) {
767 foreach my $col (@visible_columns) {
773 my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
774 $skip_next = $num_output - 1;
776 push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} });
777 push @data, ('') x $skip_next if ($skip_next);
780 $csv->print($stdout, \@data);
785 sub check_for_pdf_api {
786 return eval { require PDF::API2; 1; } ? 1 : 0;
795 SL::ReportGenerator.pm: the kivitendo way of getting data in shape
799 my $report = SL::ReportGenerator->new(\%myconfig, $form);
800 $report->set_options(%options); # optional
801 $report->set_columns(%column_defs);
802 $report->set_sort_indicator($column, $direction); # optional
803 $report->add_data($row1, $row2, @more_rows);
804 $report->generate_with_headers();
806 This creates a report object, sets a few columns, adds some data and generates a standard report.
807 Sorting of columns will be alphabetic, and options will be set to their defaults.
808 The report will be printed including table headers, html headers and http headers.
812 Imagine the following scenario:
813 There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
814 Then there may be more than one line. You add a loop in the template.
815 Then there are some options made by the user, such as hidden columns. You add more to the template.
816 Then it lacks usability. You want it to be able to sort the data. You add code for that.
817 Then there are too many results, you need pagination, you want to print or export that data..... and so on.
819 The ReportGenerator class was designed because this exact scenario happened about half a dozen times in kivitendo.
820 It's purpose is to manage all those formating, culling, sorting, and templating.
821 Which makes it almost as complicated to use as doing the work for yourself.
827 =item new \%myconfig,$form,%options
829 Creates a new ReportGenerator object, sets all given options, and returns it.
831 =item set_columns %columns
833 Sets the columns available to this report.
835 =item set_column_order @columns
837 Sets the order of columns. Any columns not present here are appended in alphabetic order.
839 =item set_sort_indicator $column,$direction
841 Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
842 Note that this is only for displaying. The data has to be presented already sorted.
844 =item add_data \@data
846 =item add_data \%data
848 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.
849 Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
850 ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
854 Adds a separator line to the report.
856 =item add_control \%data
858 Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
859 Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
860 Currently the only control element is a colspan element, which can be used as a mini header further down the report.
864 Deletes all data filled into the report, but keeps options set.
866 =item set_options %options
868 Sets options. For an incomplete list of options, see section configuration.
870 =item set_options_from_form
872 Tries to import options from the $form object given at creation
874 =item set_export_options $next_sub,@variable_list
876 Sets next_sub and additional variables needed for export.
878 =item get_attachment_basename
880 Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
882 =item generate_with_headers
884 Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
885 for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
887 =item get_visible_columns $format
889 Returns a list of columns that will be visible in the report after considering all options or match the given format.
891 =item html_format $value
893 Escapes HTML characters in $value and substitutes newlines with '<br>'. Returns the escaped $value.
895 =item prepare_html_content $column,$name,@column_headers
897 Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
898 Should not be called extrenally, since all render and generate functions invoke it anyway.
900 =item generate_html_content
902 The html generation function. Is invoked by generate_with_headers.
904 =item generate_pdf_content
906 The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
908 =item generate_csv_content
910 The CSV generation function. Uses XS_CSV to parse the information into csv.
916 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.
918 =head2 General Options
922 =item std_column_visibility
924 Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
928 Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
930 =item allow_pdf_export
932 Used to determine if a button for PDF export should be displayed. Default is yes.
934 =item allow_csv_export
936 Used to determine if a button for CSV export should be displayed. Default is yes.
940 The template to be used for HTML reports. Default is 'report_generator/html_report'.
942 =item controller_class
944 If this is used from a C<SL::Controller::Base> based controller class, pass the
945 class name here and make sure C<SL::Controller::Helper::ReportGenerator> is
946 used in the controller. That way the exports stay functional.
956 Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
958 =item orientation (landscape)
960 Landscape or portrait. Default is landscape.
964 Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
968 Default is 7. This option only affects the rendering with PDF::API2.
978 The paper margins in cm. They all default to 1.5.
982 Set to a true value if the pages should be numbered. Default is 1.
986 If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
1004 Character to enclose entries. Default is double quote (").
1008 Character to separate entries. Default is semicolon (;).
1012 Character to escape the quote_char. Default is double quote (").
1016 End of line style. Default is Unix.
1020 Include headers? Default is yes.
1028 =head1 MODULE AUTHORS
1030 Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
1032 L<http://linet-services.de>