dolibarr  20.0.0-alpha
box_graph_invoices_permonth.php
Go to the documentation of this file.
1 <?php
2 /* Copyright (C) 2013 Laurent Destailleur <eldy@users.sourceforge.net>
3  * Copyright (C) 2024 Frédéric France <frederic.france@free.fr>
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program. If not, see <https://www.gnu.org/licenses/>.
17  */
18 
24 include_once DOL_DOCUMENT_ROOT.'/core/boxes/modules_boxes.php';
25 
26 
31 {
32  public $boxcode = "invoicespermonth";
33  public $boximg = "object_bill";
34  public $boxlabel = "BoxCustomersInvoicesPerMonth";
35  public $depends = array("facture");
36 
37  public $widgettype = 'graph';
38 
39 
46  public function __construct($db, $param)
47  {
48  global $user;
49 
50  $this->db = $db;
51 
52  $this->hidden = !$user->hasRight('facture', 'lire');
53  }
54 
61  public function loadBox($max = 5)
62  {
63  global $conf, $user, $langs;
64 
65  $this->max = $max;
66 
67  $refreshaction = 'refresh_'.$this->boxcode;
68 
69  //include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facture.class.php';
70  //$facturestatic=new Facture($this->db);
71 
72  $startmonth = getDolGlobalInt('SOCIETE_FISCAL_MONTH_START', 1);
73  if (!getDolGlobalString('GRAPH_USE_FISCAL_YEAR')) {
74  $startmonth = 1;
75  }
76 
77  $text = $langs->trans("BoxCustomersInvoicesPerMonth", $max);
78  $this->info_box_head = array(
79  'text' => $text,
80  'limit'=> dol_strlen($text),
81  'graph'=> 1,
82  'sublink'=>'',
83  'subtext'=>$langs->trans("Filter"),
84  'subpicto'=>'filter.png',
85  'subclass'=>'linkobject boxfilter',
86  'target'=>'none' // Set '' to get target="_blank"
87  );
88 
89  $dir = ''; // We don't need a path because image file will not be saved into disk
90  $prefix = '';
91  $socid = 0;
92  if ($user->socid) {
93  $socid = $user->socid;
94  }
95  if (!$user->hasRight('societe', 'client', 'voir')) {
96  $prefix .= 'private-'.$user->id.'-'; // If user has no permission to see all, output dir is specific to user
97  }
98 
99  if ($user->hasRight('facture', 'lire')) {
100  $mesg = '';
101 
102  $param_year = 'DOLUSERCOOKIE_box_'.$this->boxcode.'_year';
103  $param_shownb = 'DOLUSERCOOKIE_box_'.$this->boxcode.'_shownb';
104  $param_showtot = 'DOLUSERCOOKIE_box_'.$this->boxcode.'_showtot';
105 
106  include_once DOL_DOCUMENT_ROOT.'/core/class/dolgraph.class.php';
107  include_once DOL_DOCUMENT_ROOT.'/compta/facture/class/facturestats.class.php';
108  $autosetarray = preg_split("/[,;:]+/", GETPOST('DOL_AUTOSET_COOKIE'));
109  if (in_array('DOLUSERCOOKIE_box_'.$this->boxcode, $autosetarray)) {
110  $endyear = GETPOSTINT($param_year);
111  $shownb = GETPOST($param_shownb, 'alpha');
112  $showtot = GETPOST($param_showtot, 'alpha');
113  } else {
114  $tmparray = (!empty($_COOKIE['DOLUSERCOOKIE_box_'.$this->boxcode]) ? json_decode($_COOKIE['DOLUSERCOOKIE_box_'.$this->boxcode], true) : array());
115  $endyear = (!empty($tmparray['year']) ? $tmparray['year'] : '');
116  $shownb = (!empty($tmparray['shownb']) ? $tmparray['shownb'] : '');
117  $showtot = (!empty($tmparray['showtot']) ? $tmparray['showtot'] : '');
118  }
119  if (empty($shownb) && empty($showtot)) {
120  $shownb = 1;
121  $showtot = 1;
122  }
123  $nowarray = dol_getdate(dol_now(), true);
124  if (empty($endyear)) {
125  $endyear = $nowarray['year'];
126  }
127  $startyear = $endyear - (getDolGlobalString('MAIN_NB_OF_YEAR_IN_WIDGET_GRAPH') ? ($conf->global->MAIN_NB_OF_YEAR_IN_WIDGET_GRAPH - 1) : 2); // Default is 3 years
128 
129  $mode = 'customer';
130  $WIDTH = (($shownb && $showtot) || !empty($conf->dol_optimize_smallscreen)) ? '256' : '320';
131  $HEIGHT = '192';
132 
133  $stats = new FactureStats($this->db, $socid, $mode, 0);
134 
135  // Build graphic number of object. $data = array(array('Lib',val1,val2,val3),...)
136  if ($shownb) {
137  $data1 = $stats->getNbByMonthWithPrevYear($endyear, $startyear, (GETPOST('action', 'aZ09') == $refreshaction ? -1 : (3600 * 24)), ($WIDTH < 300 ? 2 : 0), $startmonth);
138 
139  $filenamenb = $dir."/".$prefix."invoicesnbinyear-".$endyear.".png";
140  // default value for customer mode
141  $fileurlnb = DOL_URL_ROOT.'/viewimage.php?modulepart=billstats&file=invoicesnbinyear-'.$endyear.'.png';
142 
143  $px1 = new DolGraph();
144  $mesg = $px1->isGraphKo();
145  if (!$mesg) {
146  $langs->load("bills");
147 
148  $px1->SetData($data1);
149  unset($data1);
150  $i = $startyear;
151  $legend = array();
152  while ($i <= $endyear) {
153  if ($startmonth != 1) {
154  $legend[] = sprintf("%d/%d", $i - 2001, $i - 2000);
155  } else {
156  $legend[] = $i;
157  }
158  $i++;
159  }
160 
161  $px1->SetLegend($legend);
162  $px1->SetMaxValue($px1->GetCeilMaxValue());
163  $px1->SetWidth($WIDTH);
164  $px1->SetHeight($HEIGHT);
165  $px1->SetYLabel($langs->trans("NumberOfBills"));
166  $px1->SetShading(3);
167  $px1->SetHorizTickIncrement(1);
168  $px1->SetCssPrefix("cssboxes");
169  $px1->mode = 'depth';
170  $px1->SetTitle($langs->trans("NumberOfBillsByMonth"));
171 
172  $px1->draw($filenamenb, $fileurlnb);
173  }
174  }
175 
176  // Build graphic number of object. $data = array(array('Lib',val1,val2,val3),...)
177  if ($showtot) {
178  $data2 = $stats->getAmountByMonthWithPrevYear($endyear, $startyear, (GETPOST('action', 'aZ09') == $refreshaction ? -1 : (3600 * 24)), ($WIDTH < 300 ? 2 : 0), $startmonth);
179 
180  $filenamenb = $dir."/".$prefix."invoicesamountinyear-".$endyear.".png";
181  // default value for customer mode
182  $fileurlnb = DOL_URL_ROOT.'/viewimage.php?modulepart=billstats&file=invoicesamountinyear-'.$endyear.'.png';
183 
184  $px2 = new DolGraph();
185  $mesg = $px2->isGraphKo();
186  if (!$mesg) {
187  $langs->load("bills");
188 
189  $px2->SetData($data2);
190  unset($data2);
191  $i = $startyear;
192  $legend = array();
193  while ($i <= $endyear) {
194  if ($startmonth != 1) {
195  $legend[] = sprintf("%d/%d", $i - 2001, $i - 2000);
196  } else {
197  $legend[] = $i;
198  }
199  $i++;
200  }
201  $px2->SetLegend($legend);
202  $px2->SetMaxValue($px2->GetCeilMaxValue());
203  $px2->SetWidth($WIDTH);
204  $px2->SetHeight($HEIGHT);
205  $px2->SetYLabel($langs->trans("AmountOfBillsHT"));
206  $px2->SetShading(3);
207  $px2->SetHorizTickIncrement(1);
208  $px2->SetCssPrefix("cssboxes");
209  $px2->mode = 'depth';
210  $px2->SetTitle($langs->trans("AmountOfBillsByMonthHT"));
211 
212  $px2->draw($filenamenb, $fileurlnb);
213  }
214  }
215 
216  if (empty($conf->use_javascript_ajax)) {
217  $langs->load("errors");
218  $mesg = $langs->trans("WarningFeatureDisabledWithDisplayOptimizedForBlindNoJs");
219  }
220 
221  if (!$mesg) {
222  $stringtoshow = '';
223  $stringtoshow .= '<script nonce="'.getNonce().'" type="text/javascript">
224  jQuery(document).ready(function() {
225  jQuery("#idsubimg'.$this->boxcode.'").click(function() {
226  jQuery("#idfilter'.$this->boxcode.'").toggle();
227  });
228  });
229  </script>';
230  $stringtoshow .= '<div class="center hideobject" id="idfilter'.$this->boxcode.'">'; // hideobject is to start hidden
231  $stringtoshow .= '<form class="flat formboxfilter" method="POST" action="'.$_SERVER["PHP_SELF"].'">';
232  $stringtoshow .= '<input type="hidden" name="token" value="'.newToken().'">';
233  $stringtoshow .= '<input type="hidden" name="action" value="'.$refreshaction.'">';
234  $stringtoshow .= '<input type="hidden" name="page_y" value="">';
235  $stringtoshow .= '<input type="hidden" name="DOL_AUTOSET_COOKIE" value="DOLUSERCOOKIE_box_'.$this->boxcode.':year,shownb,showtot">';
236  $stringtoshow .= '<input type="checkbox" name="'.$param_shownb.'"'.($shownb ? ' checked' : '').'> '.$langs->trans("NumberOfBillsByMonth");
237  $stringtoshow .= ' &nbsp; ';
238  $stringtoshow .= '<input type="checkbox" name="'.$param_showtot.'"'.($showtot ? ' checked' : '').'> '.$langs->trans("AmountOfBillsByMonthHT");
239  $stringtoshow .= '<br>';
240  $stringtoshow .= $langs->trans("Year").' <input class="flat" size="4" type="text" name="'.$param_year.'" value="'.$endyear.'">';
241  $stringtoshow .= '<input type="image" class="reposition inline-block valigntextbottom" alt="'.$langs->trans("Refresh").'" src="'.img_picto($langs->trans("Refresh"), 'refresh.png', '', '', 1).'">';
242  $stringtoshow .= '</form>';
243  $stringtoshow .= '</div>';
244  if ($shownb && $showtot) {
245  $stringtoshow .= '<div class="fichecenter">';
246  $stringtoshow .= '<div class="fichehalfleft">';
247  }
248  if ($shownb) {
249  $stringtoshow .= $px1->show();
250  }
251  if ($shownb && $showtot) {
252  $stringtoshow .= '</div>';
253  $stringtoshow .= '<div class="fichehalfright">';
254  }
255  if ($showtot) {
256  $stringtoshow .= $px2->show();
257  }
258  if ($shownb && $showtot) {
259  $stringtoshow .= '</div>';
260  $stringtoshow .= '</div>';
261  }
262  $this->info_box_contents[0][0] = array('tr'=>'class="oddeven nohover"', 'td' => 'class="nohover center"', 'textnoformat'=>$stringtoshow);
263  } else {
264  $this->info_box_contents[0][0] = array('tr'=>'class="oddeven nohover"', 'td' => 'class="nohover left"', 'maxlength'=>500, 'text' => $mesg);
265  }
266  } else {
267  $this->info_box_contents[0][0] = array(
268  'td' => 'class="nohover left"',
269  'text' => '<span class="opacitymedium">'.$langs->trans("ReadPermissionNotAllowed").'</span>'
270  );
271  }
272  }
273 
282  public function showBox($head = null, $contents = null, $nooutput = 0)
283  {
284  return parent::showBox($this->info_box_head, $this->info_box_contents, $nooutput);
285  }
286 }
Class to build graphs.
Class to manage stats for invoices (customer and supplier)
Class ModeleBoxes.
Class to manage the box to show invoices per month graph.
showBox($head=null, $contents=null, $nooutput=0)
Method to show box.
loadBox($max=5)
Load data into info_box_contents array to show array later.
img_picto($titlealt, $picto, $moreatt='', $pictoisfullpath=0, $srconly=0, $notitle=0, $alt='', $morecss='', $marginleftonlyshort=2)
Show picto whatever it's its name (generic function)
GETPOSTINT($paramname, $method=0)
Return the value of a $_GET or $_POST supervariable, converted into integer.
dol_strlen($string, $stringencoding='UTF-8')
Make a strlen call.
dol_now($mode='auto')
Return date for now.
getDolGlobalInt($key, $default=0)
Return a Dolibarr global constant int value.
GETPOST($paramname, $check='alphanohtml', $method=0, $filter=null, $options=null, $noreplace=0)
Return value of a param into GET or POST supervariable.
getDolGlobalString($key, $default='')
Return dolibarr global constant string value.
dol_getdate($timestamp, $fast=false, $forcetimezone='')
Return an array with locale date info.