contratstats.class.php

<?php
/* Copyright (C) 2003       Rodolphe Quiedeville        <rodolphe@quiedeville.org>
 * Copyright (c) 2005-2013  Laurent Destailleur         <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2012  Regis Houssin               <regis.houssin@inodbox.com>
 * Copyright (C) 2012       Marcos García               <marcosgdf@gmail.com>
 * Copyright (C) 2020       Maxime DEMAREST             <maxime@indelog.com>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.fr>
 * Copyright (C) 2024       MDW                         <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2025       Charlene Benke              <charlene@patas-monkey.com>
 * Copyright (C) 2026       Alexandre Spangaro          <alexandre@inovea-conseil.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.'/contrat/class/contrat.class.php';
include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
 
 
class ContratStats extends Stats
{
  public $table_element;
 
  public $socid;
 
  public $userid;
 
  public $from;
 
  public $from_line;
 
  public $field;
 
  public $field_line;
 
  public $categ_link;
 
  public $where = '';
 
  public $join;
 
 
  public function __construct($db, $socid, $mode, $userid = 0, $typentid = 0, $categid = 0)
  {
    global $user, $conf;
 
    $this->db = $db;
 
    $this->socid = ($socid > 0 ? $socid : 0);
    $this->userid = $userid;
    $this->cachefilesuffix = $mode;
    $this->join = '';
 
    $object = new Contrat($this->db);
    $this->from = MAIN_DB_PREFIX.$object->table_element." as c";
    $this->from_line = MAIN_DB_PREFIX.$object->table_element_line." as cd";
    $this->field = 'total_ht';
    $this->field_line = 'total_ht';
    //$this->where .= " c.fk_statut > 0"; // Not draft and not cancelled
    $this->categ_link = MAIN_DB_PREFIX.'categorie_societe';
 
    //$this->where.= " AND c.fk_soc = s.rowid AND c.entity = ".$conf->entity;
    $this->where .= ($this->where ? ' AND ' : '').'c.entity IN ('.getEntity('contract').')';
 
    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);
    }
 
    if ($typentid) {
      $this->join .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe as s ON s.rowid = c.fk_soc';
      $this->where .= ' AND s.fk_typent = '.((int) $typentid);
    }
 
    if ($categid) {
      $this->where .= ' AND EXISTS (SELECT rowid FROM '.$this->categ_link.' as cats WHERE cats.fk_soc = c.fk_soc AND cats.fk_categorie = '.((int) $categid).')';
    }
  }
 
  public function getNbByMonth($year, $format = 0)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_contrat,'%m') as dm, COUNT(*) as nb";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (empty($user->socid) && !$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 c.date_contrat 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_contrat,'%Y') as dm, COUNT(*) as nb, SUM(c.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (empty($user->socid) && !$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->_getNbByYear($sql);
  }
 
  public function getAmountByMonth($year, $format = 0)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_contrat,'%m') as dm, count(cd.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    $sql .= " INNER JOIN ".$this->db->sanitize($this->from_line, 0, 1, 1). " ON c.rowid = cd.fk_contrat";
    if (empty($user->socid) && !$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 c.date_contrat 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->_getAmountByMonth($year, $sql, $format);
    return $res;
  }
 
  public function getAverageByMonth($year)
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_contrat,'%m') as dm, AVG(c.".$this->db->sanitize($this->field).")";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    if (empty($user->socid) && !$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 c.date_contrat 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');
 
    return $this->_getAverageByMonth($year, $sql);
  }
 
  public function getAllByYear()
  {
    global $user;
 
    $sql = "SELECT date_format(c.date_contrat,'%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 (empty($user->socid) && !$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 year";
    $sql .= $this->db->order('year', 'DESC');
 
    return $this->_getAllByYear($sql);
  }
 
  public function getAllByProduct($year, $limit = 10)
  {
    global $user;
 
    $sql = "SELECT product.ref, COUNT(product.ref) as nb, SUM(tl.".$this->field_line.") as total, AVG(tl.".$this->field_line.") as avg";
    $sql .= " FROM ".$this->db->sanitize($this->from, 0, 1, 1);
    $sql .= " INNER JOIN ".$this->db->sanitize($this->from_line, 0, 1, 1)." ON c.rowid = tl.fk_commande";
    $sql .= " INNER JOIN ".MAIN_DB_PREFIX."product as product ON tl.fk_product = product.rowid";
    if (empty($user->socid) && !$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 .= " AND c.date_contrat BETWEEN '".$this->db->idate(dol_get_first_day($year, 1, false))."' AND '".$this->db->idate(dol_get_last_day($year, 12, false))."'";
    $sql .= " GROUP BY product.ref";
    $sql .= $this->db->order('nb', 'DESC');
    //$sql.= $this->db->plimit(20);
 
    return $this->_getAllByProduct($sql, $limit);
  }
}