SL/Controller/Helper/ReportGenerator/ControlRow/Separator.pm

   1 package SL::Controller::Helper::ReportGenerator::ControlRow::Separator;
   2
   3 use strict;
   4
   5 use parent qw(SL::Controller::Helper::ReportGenerator::ControlRow::Base);
   6
   7
   8 sub validate_params {
   9   return;
  10 }
  11
  12 sub set_data {
  13   my ($self, $report) = @_;
  14
  15   $report->add_separator();
  16 }
  17
  18
  19 1;
  20
  21
  22 __END__
  23
  24 =encoding utf-8
  25
  26 =head1 NAME
  27
  28 SL::Controller::Helper::ReportGenerator::ControlRow::Separator - an
  29 implementaion of a control row class to display a separator
  30
  31 =head1 DESCRIPTION
  32
  33 This class implements a control row for the report generator helper to display
  34 a separator.
  35
  36 =head1 SYNOPSIS
  37
  38   use SL::Controller::Helper::ReportGenerator;
  39   use SL::Controller::Helper::ReportGenerator::ControlRow qw(make_control_row);
  40
  41   sub action_list {
  42     my ($self) = @_;
  43
  44     # Set up the report generator instance. In this example this is
  45     # hidden in "prepare_report".
  46     my $report = $self->prepare_report;
  47
  48     # Get objects from database.
  49     my $objects = SL::DB::Manager::TimeRecording->get_all(...);
  50
  51     # Add a separator
  52     push @$objects, make_control_row("separator");
  53
  54     # Let report generator create the output.
  55     $self->report_generator_list_objects(
  56       report  => $report,
  57       objects => $objects,
  58     );
  59   }
  60
  61 =head1 PARAMETERS
  62
  63 This control row does not use any parameters.
  64
  65 =head1 AUTHOR
  66
  67 Bernd Bleßmann E<lt>bernd@kivitendo-premium.deE<gt>
  68
  69 =cut