FS/FS/Report/Table/Daily.pm

   1 package FS::Report::Table::Daily;
   2
   3 use strict;
   4 use base 'FS::Report::Table';
   5 use DateTime;
   6 use FS::Conf;
   7
   8 =head1 NAME
   9
  10 FS::Report::Table::Daily - Tables of report data, indexed daily
  11
  12 =head1 SYNOPSIS
  13
  14   use FS::Report::Table::Daily;
  15
  16   my $report = new FS::Report::Table::Daily (
  17     'items' => [ 'invoiced', 'netsales', 'credits', 'receipts', ],
  18     'start_month' => 4,
  19     'start_year'  => 2000,
  20     'end_month'   => 4,
  21     'end_year'    => 2020,
  22     'start_day'   => 2,
  23     'end_day'     => 27,
  24     #opt
  25     'agentnum'    => 54
  26     'cust_classnum' => [ 1,2,4 ],
  27     'params'      => [ [ 'paramsfor', 'item_one' ], [ 'item', 'two' ] ], # ...
  28     'remove_empty' => 1, #collapse empty rows, default 0
  29     'item_labels' => [ ], #useful with remove_empty
  30   );
  31
  32   my $data = $report->data;
  33
  34 =head1 METHODS
  35
  36 =over 4
  37
  38 =item data
  39
  40 Returns a hashref of data (!! describe)
  41
  42 =cut
  43
  44 sub data {
  45   my $self = shift;
  46
  47   my $sday = $self->{'start_day'};
  48   my $smonth = $self->{'start_month'};
  49   my $syear = $self->{'start_year'} + 1900; # temporary kludge
  50   my $eday = $self->{'end_day'};
  51   my $emonth = $self->{'end_month'};
  52   my $eyear = $self->{'end_year'} + 1900;
  53   my $agentnum = $self->{'agentnum'};
  54   my $cust_classnum = $self->{'cust_classnum'} || [];
  55   $cust_classnum = [ $cust_classnum ] if !ref($cust_classnum);
  56
  57   #these need to get generalized, sheesh
  58   my %data = (
  59     # rows (time intervals)
  60     speriod   => [], # start timestamps
  61     eperiod   => [], # end timestamps
  62     label     => [], # date labels
  63     data      => [], # arrayrefs of column values
  64
  65     # columns (observables + query parameters)
  66     items         => $self->{'items'},
  67     item_labels   => $self->{'item_labels'} || $self->{'items'},
  68     colors        => $self->{'colors'}, # no default?
  69     links         => $self->{'links'} || [],
  70   );
  71
  72   my $sdate = DateTime->new(
  73                 day => $sday,
  74                 month => $smonth,
  75                 year => $syear,
  76                 time_zone => 'local'
  77               );
  78   my $edate = DateTime->new(
  79                 day => $eday,
  80                 month => $emonth,
  81                 year => $eyear,
  82                 time_zone => 'local'
  83               )->add(days => 1); # include all of the end day
  84
  85   my $conf = FS::Conf->new;
  86   my $date_format = $conf->config('date_format') || '%d/%m/%Y';
  87
  88   while ( $sdate < $edate ) {
  89     push @{$data{label}}, $sdate->strftime($date_format);
  90
  91     my $speriod = $sdate->epoch;
  92     $sdate->add(days => 1);
  93     my $eperiod = $sdate->epoch;;
  94
  95     push @{$data{speriod}}, $speriod;
  96     push @{$data{eperiod}}, $eperiod;
  97
  98     my $col = 0;
  99     my @items = @{$self->{'items'}};
 100     my $i;
 101     for ( $i = 0; $i < scalar(@items); $i++ ) {
 102           my $item = $items[$i];
 103           my @param = $self->{'params'} ? @{ $self->{'params'}[$col] }: ();
 104           push @param, 'cust_classnum' => $cust_classnum if @$cust_classnum;
 105           my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
 106           push @{$data{data}->[$col++]}, $value;
 107     }
 108   }
 109
 110   $data{'items'}       = $self->{'items'};
 111   $data{'item_labels'} = $self->{'item_labels'} || $self->{'items'};
 112   $data{'colors'}      = $self->{'colors'};
 113   $data{'links'}       = $self->{'links'} || [];
 114
 115   if ( $self->{'remove_empty'} ) {
 116
 117     my $col = 0;
 118     #these need to get generalized, sheesh
 119     my @newitems = ();
 120     my @newlabels = ();
 121     my @newdata = ();
 122     my @newcolors = ();
 123     my @newlinks = ();
 124     my @indices = ();
 125     foreach my $item ( @{$self->{'items'}} ) {
 126
 127       my $is_nonzero = scalar( grep { $_ != 0 } @{ $data{'data'}->[$col] });
 128       next if ($self->{'remove_empty'} and $is_nonzero == 0);
 129       # no daily reports can normalize yet
 130       push @newitems,  $data{'items'}->[$col];
 131       push @newlabels, $data{'item_labels'}->[$col];
 132       push @newdata,   $data{'data'}->[$col];
 133       push @newcolors, $data{'colors'}->[$col];
 134       push @newlinks,  $data{'links'}->[$col];
 135       push @indices, $col;
 136
 137     } continue {
 138       $col++;
 139     }
 140
 141     $data{'items'}       = \@newitems;
 142     $data{'item_labels'} = \@newlabels;
 143     $data{'data'}        = \@newdata;
 144     $data{'colors'}      = \@newcolors;
 145     $data{'links'}       = \@newlinks;
 146     $data{'indices'}     = \@indices;
 147
 148   } else { # not doing remove_empty; report back that all columns are included
 149     $data{'indices'} = [ 0 .. scalar( @{$self->{'items'}} ) - 1 ];
 150   }
 151
 152   \%data;
 153
 154 }
 155
 156 =back
 157
 158 =head1 BUGS
 159
 160 Documentation.
 161
 162 =head1 SEE ALSO
 163
 164 =cut
 165
 166 1;