expeditionstats.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003       Rodolphe Quiedeville  <rodolphe@quiedeville.org>
 * Copyright (c) 2005-2013  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2009  Regis Houssin         <regis.houssin@inodbox.com>
 * Copyright (C) 2011       Juanjo Menent     <jmenent@2byte.es>
 * Copyright (C) 2024-2026  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025   Charlene Benke      <charlene@patas-monkey.com>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <https://www.gnu.org/licenses/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/class/stats.class.php';
include_once DOL_DOCUMENT_ROOT.'/expedition/class/expedition.class.php';
include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
 
 
class ExpeditionStats extends Stats
{
  public $table_element;
 
  public $socid;
 
  public $userid;
 
  public $from;
 
  public $join;
 
  public $field;
 
  public $where;
 
 
  public function __construct($db, $socid, $mode, $userid = 0)
  {
    global $user, $conf;
 
    $this->db = $db;
 
    $this->socid = ($socid > 0 ? $socid : 0);
    $this->userid = $userid;
    $this->cachefilesuffix = $mode;
 
    $object = new Expedition($this->db);
    $this->from = MAIN_DB_PREFIX.$object->table_element." as c";
    //$this->from.= ", ".MAIN_DB_PREFIX."societe as s";
    $this->field = 'weight'; // Warning, unit of weight is NOT USED AND MUST BE
    $this->where .= " c.fk_statut > 0"; // Not draft and not cancelled
 
    //$this->where.= " AND c.fk_soc = s.rowid AND c.entity = ".$conf->entity;
    $this->where .= " AND c.entity = ".$conf->entity;
 
    if ($this->socid) {
      $this->where .= " AND c.fk_soc = ".((int) $this->socid);
    }
    if ($this->userid > 0) {
      $this->where .= ' AND c.fk_user_author = '.((int) $this->userid);
    }
  }
 
  public function getNbByMonth($year, $format = 0)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_valid,'%m') as dm, COUNT(*) as nb";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (!$user->hasRight('societe', 'client', 'voir')) {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON c.fk_soc = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
    }
    $sql .= " WHERE c.date_valid BETWEEN '".$this->db->idate(dol_get_first_day($year))."' AND '".$this->db->idate(dol_get_last_day($year))."'";
    $sql .= " AND ".$this->where;
    $sql .= " GROUP BY dm";
    $sql .= $this->db->order('dm', 'DESC');
 
    $res = $this->_getNbByMonth($year, $sql, $format);
    return $res;
  }
 
  public function getNbByYear()
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_valid,'%Y') as dm, COUNT(*) as nb, SUM(c.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (!$user->hasRight('societe', 'client', 'voir')) {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON c.fk_soc = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
    }
    $sql .= " WHERE ".$this->where;
    $sql .= " GROUP BY dm";
    $sql .= $this->db->order('dm', 'DESC');
 
    return $this->_getNbByYear($sql);
  }
 
  public function getAmountByMonth($year, $format = 0)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_valid,'%m') as dm, SUM(c.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (!$user->hasRight('societe', 'client', 'voir')) {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON c.fk_soc = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
    }
    $sql .= $this->join;
    $sql .= " WHERE ".$this->where;
    $sql .= " GROUP BY dm";
    $sql .= $this->db->order('dm', 'DESC');
 
    $res = $this->_getAmountByMonth($year, $sql, $format);
    return $res;
  }
 
  public function getAverageByMonth($year)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_valid,'%m') as dm, AVG(c.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (!$user->hasRight('societe', 'client', 'voir')) {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON c.fk_soc = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
    }
    $sql .= $this->join;
    $sql .= " WHERE ".$this->where;
    $sql .= " GROUP BY dm";
    $sql .= $this->db->order('dm', 'DESC');
 
    return $this->_getAverageByMonth($year, $sql);
  }
 
  public function getAllByYear()
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_valid,'%Y') as year, COUNT(*) as nb, SUM(c.".$this->db->sanitize($this->field).") as total, AVG(".$this->db->sanitize($this->field).") as avg";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (!$user->hasRight('societe', 'client', 'voir')) {
      $sql .= " INNER JOIN ".MAIN_DB_PREFIX."societe_commerciaux as sc ON c.fk_soc = sc.fk_soc AND sc.fk_user = ".((int) $user->id);
    }
    $sql .= " WHERE ".$this->where;
    $sql .= " GROUP BY year";
    $sql .= $this->db->order('year', 'DESC');
 
    return $this->_getAllByYear($sql);
  }
}