X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FReportGenerator.pm;h=2e12a2acc51dabf9fb74b1bdfbea016de3fb1cfd;hb=2a5c1eb378137a5dd14da64b9875dc947ec2557b;hp=09ab7bd7bb7c33e8c17391e6b07445d2ea0074ad;hpb=db3b23aa8ab6baaa3854259b59b033fbd23541ad;p=kivitendo-erp.git diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm index 09ab7bd7b..2e12a2acc 100644 --- a/SL/ReportGenerator.pm +++ b/SL/ReportGenerator.pm @@ -47,6 +47,7 @@ sub new { 'escape_char' => '"', 'eol_style' => 'Unix', 'headers' => 1, + 'encoding' => 'UTF-8', }, }; $self->{export} = { @@ -121,7 +122,7 @@ sub add_data { $row->{$column}->{align} = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align}); } - foreach my $field (qw(data link)) { + foreach my $field (qw(data link link_class)) { map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row }; } } @@ -287,6 +288,7 @@ sub prepare_html_content { 'align' => $column->{align}, 'link' => $column->{link}, 'text' => $column->{text}, + 'raw_header_data' => $column->{raw_header_data}, 'show_sort_indicator' => $name eq $opts->{sort_indicator_column}, 'sort_indicator_direction' => $opts->{sort_indicator_direction}, }; @@ -351,6 +353,7 @@ sub prepare_html_content { push @{ $col->{CELL_ROWS} }, { 'data' => '' . $self->html_format($col->{data}->[$i]), 'link' => $col->{link}->[$i], + link_class => $col->{link_class}->[$i], }; } @@ -701,10 +704,10 @@ sub _print_content { } sub _handle_quoting_and_encoding { - my ($self, $text, $do_unquote) = @_; + my ($self, $text, $do_unquote, $encoding) = @_; $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote; - $text = Encode::encode('UTF-8', $text); + $text = Encode::encode($encoding || 'UTF-8', $text); return $text; } @@ -743,7 +746,7 @@ sub _generate_csv_content { if ($opts->{headers}) { if (!$self->{custom_headers}) { - $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @visible_columns ]); + $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1, $opts->{encoding}) } @visible_columns ]); } else { foreach my $row (@{ $self->{custom_headers} }) { @@ -751,7 +754,7 @@ sub _generate_csv_content { foreach my $col (@{ $row }) { my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1; - push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1)) x $num_output; + push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1, $opts->{encoding})) x $num_output; } $csv->print($stdout, $fields); @@ -773,7 +776,7 @@ sub _generate_csv_content { my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1; $skip_next = $num_output - 1; - push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} }); + push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0, $opts->{encoding}) } @{ $row->{$col}->{data} }); push @data, ('') x $skip_next if ($skip_next); } @@ -818,7 +821,7 @@ Then there are too many results, you need pagination, you want to print or expor The ReportGenerator class was designed because this exact scenario happened about half a dozen times in kivitendo. It's purpose is to manage all those formating, culling, sorting, and templating. -Which makes it almost as complicated to use as doing the work for yourself. +Which makes it almost as complicated to use as doing the work by yourself. =head1 FUNCTIONS @@ -838,16 +841,21 @@ Sets the order of columns. Any columns not present here are appended in alphabet =item set_sort_indicator $column,$direction -Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true. -Note that this is only for displaying. The data has to be presented already sorted. +Sets sorting of the table by specifying a column and a direction, where the direction will be evaluated to ascending if true. +Note that this is only for displaying. The data has to have already been sorted when it was added. =item add_data \@data =item add_data \%data -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. -Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted. -ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by. +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. Every line will be expected to +be in a key => value format. Note that the rows have to already have been +sorted. + +The ReportGenerator is only able to display pre-sorted data and to indicate by +which column and in which direction the data has been sorted via visual clues +in the column headers. It also provides links to invert the sort direction. =item add_separator @@ -856,12 +864,12 @@ Adds a separator line to the report. =item add_control \%data Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot. -Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template. +Every control element needs to set IS_CONTROL_DATA, in order to be recognized by the template. Currently the only control element is a colspan element, which can be used as a mini header further down the report. =item clear_data -Deletes all data filled into the report, but keeps options set. +Deletes all data added to the report, but keeps options set. =item set_options %options @@ -895,7 +903,7 @@ Escapes HTML characters in $value and substitutes newlines with '
'. Returns =item prepare_html_content $column,$name,@column_headers Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked. -Should not be called extrenally, since all render and generate functions invoke it anyway. +Should not be called externally, since all render and generate functions invoke it anyway. =item generate_html_content @@ -1019,6 +1027,10 @@ End of line style. Default is Unix. Include headers? Default is yes. +=item encoding + +Character encoding. Default is UTF-8. + =back =head1 SEE ALO