make new gross sales calculation optional, #25943
[freeside.git] / httemplate / graph / elements / monthly.html
1 <%doc>
2
3 Example:
4
5   include('elements/monthly.html',
6     #required
7     'title'           => 'Page title',
8     'items'           => \@items,
9     'labels'          => \@labels,       # or \%labels (keys are items)
10
11     #required?
12     'colors'          => \@colors,       # or \%colors,
13
14     #recommended
15     'graph_labels'    => \@graph_labels, # or \%graph_labels,
16
17     #optional
18     'params'          => \@params, # opt,
19     'links'           => \@links,      # or \%link, #opt
20     'link_fromparam'  => 'param_from', #defaults to 'begin'
21     'link_toparam'    => 'param_to',   #defaults to 'end'
22     'daily'           => 1, # omit for monthly granularity
23     'no_graph'        => \@no_graph, # items to leave off the graph (subtotals)
24
25     #optional, pulled from CGI params if not specified
26     'start_month'     => $smonth,
27     'start_year'      => $syear,
28     'end_month'       => $emonth,
29     'end_year'        => $eyear,
30     '12mo'            => 0,
31
32     #optional, pulled from CGI params if not specified, 
33     #only if 'daily' option is given
34     'start_day'       => $sday,
35     'end_day'         => $eday,
36
37     #optional
38     'agentnum'        => $agentnum,
39     'refnum'          => $refnum,
40     'cust_classnum'   => \@classnums,
41     'nototal'         => 1,
42     'graph_type'      => 'LinesPoints',
43     'remove_empty'    => 1,
44     'bottom_total'    => 1,
45     'sprintf'         => '%u', #sprintf format, overrides default %.2f
46     'disable_money'   => 1,
47   );
48
49 </%doc>
50 <% include('report.html',
51             'items'         => $data->{'items'},
52             'data'          => $data->{'data'},
53             'row_labels'    => $data->{'item_labels'},
54             'graph_labels'  => \@graph_labels,
55             'col_labels'    => $col_labels,
56             'axis_labels'   => $data->{label},
57             'colors'        => \@colors,
58             'links'         => \@links,
59             'no_graph'      => \@no_graph,
60             'bottom_link'   => \@bottom_link,
61             'transpose'     => $opt{'daily'},
62             map { $_, $opt{$_} } (qw(title
63                                     nototal
64                                     graph_type
65                                     bottom_total
66                                     sprintf
67                                     disable_money
68                                     chart_options)),
69           ) %>
70 <%init>
71
72 my(%opt) = @_;
73 $opt{'debug'} ||= $cgi->param('debug');
74
75 my $conf = new FS::Conf;
76 my $money_char = $opt{'disable_money'} ? '' : $conf->config('money_char');
77
78 my $fromparam = $opt{'link_fromparam'} || 'begin';
79 my $toparam   = $opt{'link_toparam'} || 'end';
80
81 my @items = @{ $opt{'items'} };
82
83 foreach my $other (qw( labels graph_labels colors links )) {
84   if ( ref($opt{$other}) eq 'HASH' ) {
85     $opt{$other} = [ map $opt{$other}{$_}, @items ];
86   }
87 }
88
89 my @mon = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
90
91 #find first month
92 $opt{'start_month'} ||= $cgi->param('start_month'); # || $curmon+1;
93 $opt{'start_year'}  ||= $cgi->param('start_year'); # || 1899+$curyear;
94
95 #find last month
96 $opt{'end_month'} ||= $cgi->param('end_month'); # || $curmon+1;
97 $opt{'end_year'}  ||= $cgi->param('end_year'); # || 1900+$curyear;
98
99 $opt{'12mo'} ||= $cgi->param('12mo') ? 1 : 0;
100
101 $opt{'projection'} ||= $cgi->param('projection') ? 1 : 0;
102
103 if ( $opt{'daily'} ) { # daily granularity
104     $opt{'start_day'} ||= $cgi->param('start_day');
105     $opt{'end_day'} ||= $cgi->param('end_day');
106 }
107
108 my %reportopts = (
109       'items'        => \@items,
110       'params'       => $opt{'params'},
111       'item_labels'  => ( $cgi->param('_type') =~ /^(png)$/ 
112                             ? $opt{'graph_labels'}
113                             : $opt{'labels'}
114                         ),
115       'colors'       => $opt{'colors'},
116       'links'        => $opt{'links'},
117
118       'start_day'    => $opt{'start_day'},
119       'start_month'  => $opt{'start_month'},
120       'start_year'   => $opt{'start_year'},
121       'end_day'      => $opt{'end_day'},
122       'end_month'    => $opt{'end_month'},
123       'end_year'     => $opt{'end_year'},
124       '12mo'         => $opt{'12mo'},
125       'projection'   => $opt{'projection'},
126       'agentnum'     => $opt{'agentnum'},
127       'refnum'       => $opt{'refnum'},
128       'cust_classnum'=> $opt{'cust_classnum'},
129       'remove_empty' => $opt{'remove_empty'},
130       'doublemonths' => $opt{'doublemonths'},
131       'normalize'    => $opt{'normalize'},
132 );
133
134 warn Dumper({ 'REPORTOPTS' => \%reportopts }) if $opt{'debug'};
135
136 my $report;
137 $report = new FS::Report::Table::Daily(%reportopts) if $opt{'daily'};
138 $report = new FS::Report::Table::Monthly(%reportopts) unless $opt{'daily'};
139 my $data = $report->data;
140
141 warn Dumper({'DATA' => $data}) if $opt{'debug'};
142
143 if ( $data->{'error'} ) {
144   die $data->{'error'}; # could be smarter
145 }
146
147 my $col_labels = [ map { my $m = $_; $m =~ s/^(\d+)\//$mon[$1-1] / ; $m }
148                              @{$data->{label}} ];
149 $col_labels = $data->{label} if $opt{'daily'};
150
151 my @colors;
152 my @graph_labels;
153 my @no_graph;
154 #if ( $opt{'remove_empty'} ) { # no, always do this
155   # then filter out per-item things for collapsed rows
156 foreach my $i (@{ $data->{'indices'} }) {
157   push @colors,       $opt{'colors'}[$i];
158   push @graph_labels, $opt{'graph_labels'}[$i];
159   push @no_graph,     $opt{'no_graph'}[$i];
160 }
161
162 my @links;
163 foreach my $link (@{ $data->{'links'} }) {
164   my @speriod = @{$data->{'speriod'}};
165   my @eperiod = @{$data->{'eperiod'}};
166   my ($begin, $end) = ($fromparam, $toparam);
167
168   my @new = ( $link );
169   if(ref($link)) {
170     $begin = $link->{'fromparam'};
171     $end   = $link->{'toparam'};
172     @new = ( $link->{'link'} );
173   }
174   while(@speriod) {
175     push @new, "$begin=". shift(@speriod).";$end=".shift(@eperiod);
176   }
177   if(! $opt{'nototal'}) {
178     push @new, "$begin=". $data->{'speriod'}[0] . ";$end=". $data->{'eperiod'}[-1];
179   }
180   push @links, \@new;
181 }
182
183 my @bottom_link;
184 if($opt{'bottom_link'}) {
185   my @speriod = (@{$data->{'speriod'}}, $data->{'speriod'}[0]);
186   my @eperiod = (@{$data->{'eperiod'}}, $data->{'eperiod'}[-1]);
187   
188   push @bottom_link, $opt{'bottom_link'};
189   while(@speriod) {
190     push @bottom_link, "$fromparam=". shift(@speriod). ";$toparam=". shift(@eperiod);
191   }
192 }
193
194 </%init>