<?php
/* Copyright (C) 2018      Alexandre Spangaro   <aspangaro@open-dsi.fr>
 * Copyright (c) 2018      Fidesio              <contact@fidesio.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/>.
 */

/**
 *  \file       htdocs/salaries/class/salariesstats.class.php
 *  \ingroup    salaries
 *  \brief      Fichier de la classe de gestion des stats des salaires
 */
include_once DOL_DOCUMENT_ROOT.'/core/class/stats.class.php';
include_once DOL_DOCUMENT_ROOT.'/salaries/class/paymentsalary.class.php';

/**
 *	Classe permettant la gestion des stats des salaires
 */
class SalariesStats extends Stats
{
    /**
     * @var string Name of table without prefix where object is stored
     */
    public $table_element;

    public $socid;
    public $userid;

    public $from;
    public $field;
    public $where;

    /**
     * Constructor
     *
     * @param   DoliDB      $db        Database handler
     * @param   int         $socid     Id third party
     * @param   mixed       $userid    Id user for filter or array of user ids
     * @return  void
     */
    public function __construct($db, $socid = 0, $userid = 0)
    {
        global $conf;

        $this->db = $db;
        $this->socid = $socid;
        $this->userid = $userid;

        $object = new PaymentSalary($this->db);
        $this->from = MAIN_DB_PREFIX.$object->table_element;
        $this->field = 'amount';

        $this->where .= " entity = ".$conf->entity;
        if ($this->socid) {
            $this->where .= " AND fk_soc = ".$this->socid;
        }
        if (is_array($this->userid) && count($this->userid) > 0) $this->where .= ' AND fk_user IN ('.join(',', $this->userid).')';
        elseif ($this->userid > 0) $this->where .= ' AND fk_user = '.$this->userid;
    }


    /**
     *  Return the number of salary by year
     *
     *	@return		array	Array of values
     */
    public function getNbByYear()
    {
        $sql = "SELECT YEAR(datep) as dm, count(*)";
        $sql .= " FROM ".$this->from;
        $sql .= " GROUP BY dm DESC";
        $sql .= " WHERE ".$this->where;

        return $this->_getNbByYear($sql);
    }


    /**
     *  Return the number of salary by month, for a given year
     *
     *	@param	string	$year		Year to scan
     *	@param	int		$format		0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month
     *	@return	array				Array of values
     */
    public function getNbByMonth($year, $format = 0)
    {
        $sql = "SELECT MONTH(datep) as dm, count(*)";
        $sql .= " FROM ".$this->from;
        $sql .= " WHERE YEAR(datep) = ".$year;
        $sql .= " AND ".$this->where;
        $sql .= " GROUP BY dm";
        $sql .= $this->db->order('dm', 'DESC');

        $res = $this->_getNbByMonth($year, $sql, $format);
        //var_dump($res);print '<br>';
        return $res;
    }


    /**
     * 	Return amount of salaries by month for a given year
     *
     *	@param	int		$year		Year to scan
    *	@param	int		$format		0=Label of abscissa is a translated text, 1=Label of abscissa is month number, 2=Label of abscissa is first letter of month
     *	@return	array				Array of values
     */
    public function getAmountByMonth($year, $format = 0)
    {
        $sql = "SELECT date_format(datep,'%m') as dm, sum(".$this->field.")";
        $sql .= " FROM ".$this->from;
        $sql .= " WHERE date_format(datep,'%Y') = '".$year."'";
        $sql .= " AND ".$this->where;
        $sql .= " GROUP BY dm";
        $sql .= $this->db->order('dm', 'DESC');

        $res = $this->_getAmountByMonth($year, $sql, $format);
        //var_dump($res);print '<br>';

        return $res;
    }

    /**
     *	Return average amount
     *
     *	@param	int		$year		Year to scan
     *	@return	array				Array of values
     */
    public function getAverageByMonth($year)
    {
        $sql = "SELECT date_format(datep,'%m') as dm, avg(".$this->field.")";
        $sql .= " FROM ".$this->from;
        $sql .= " WHERE date_format(datep,'%Y') = '".$year."'";
        $sql .= " AND ".$this->where;
        $sql .= " GROUP BY dm";
        $sql .= $this->db->order('dm', 'DESC');

        return $this->_getAverageByMonth($year, $sql);
    }

    /**
     *	Return nb, total and average
     *
     *	@return	array				Array of values
     */
    public function getAllByYear()
    {
        $sql = "SELECT date_format(datep,'%Y') as year, count(*) as nb, sum(".$this->field.") as total, avg(".$this->field.") as avg";
        $sql .= " FROM ".$this->from;
        $sql .= " WHERE ".$this->where;
        $sql .= " GROUP BY year";
        $sql .= $this->db->order('year', 'DESC');

        return $this->_getAllByYear($sql);
    }
}
