fiscalyear.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2014-2020  Alexandre Spangaro  <aspangaro@open-dsi.fr>
 * Copyright (C) 2020       OScss-Shop          <support@oscss-shop.fr>
 *
 *
 * 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/>.
 */

require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';

class Fiscalyear extends CommonObject
{
  public $element = 'fiscalyear';

  public $picto = 'technic';

  public $table_element = 'accounting_fiscalyear';

  public $table_element_line = '';

  public $fk_element = '';

  public $ismultientitymanaged = 1;

  public $rowid;

  public $label;

  public $date_start;

  public $date_end;

  public $datec;

  public $statut; // 0=open, 1=closed

  public $entity;

  public $statuts = array();
  public $statuts_short = array();


  public function __construct(DoliDB $db)
  {
    global $langs;

    $this->db = $db;

    $this->statuts_short = array(0 => 'Opened', 1 => 'Closed');
    $this->statuts = array(0 => 'Opened', 1 => 'Closed');
  }

  public function create($user)
  {
    global $conf;

    $error = 0;

    $now = dol_now();

    $this->db->begin();

    $sql = "INSERT INTO ".MAIN_DB_PREFIX."accounting_fiscalyear (";
    $sql .= "label";
    $sql .= ", date_start";
    $sql .= ", date_end";
    $sql .= ", statut";
    $sql .= ", entity";
    $sql .= ", datec";
    $sql .= ", fk_user_author";
    $sql .= ") VALUES (";
    $sql .= " '".$this->db->escape($this->label)."'";
    $sql .= ", '".$this->db->idate($this->date_start)."'";
    $sql .= ", ".($this->date_end ? "'".$this->db->idate($this->date_end)."'" : "null");
    $sql .= ", 0";
    $sql .= ", ".$conf->entity;
    $sql .= ", '".$this->db->idate($now)."'";
    $sql .= ", ".$user->id;
    $sql .= ")";

    dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX."accounting_fiscalyear");

      $result = $this->update($user);
      if ($result > 0)
      {
        $this->db->commit();
        return $this->id;
      } else {
        $this->error = $this->db->lasterror();
        $this->db->rollback();
        return $result;
      }
    } else {
      $this->error = $this->db->lasterror()." sql=".$sql;
      $this->db->rollback();
      return -1;
    }
  }

  public function update($user)
  {
    global $langs;

    // Check parameters
    if (empty($this->date_start) && empty($this->date_end))
    {
      $this->error = 'ErrorBadParameter';
      return -1;
    }

    $this->db->begin();

    $sql = "UPDATE ".MAIN_DB_PREFIX."accounting_fiscalyear";
    $sql .= " SET label = '".$this->db->escape($this->label)."'";
    $sql .= ", date_start = '".$this->db->idate($this->date_start)."'";
    $sql .= ", date_end = ".($this->date_end ? "'".$this->db->idate($this->date_end)."'" : "null");
    $sql .= ", statut = '".$this->db->escape($this->statut ? $this->statut : 0)."'";
    $sql .= ", fk_user_modif = ".$user->id;
    $sql .= " WHERE rowid = ".$this->id;

    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      dol_syslog($this->error, LOG_ERR);
      $this->db->rollback();
      return -1;
    }
  }

  public function fetch($id)
  {
    $sql = "SELECT rowid, label, date_start, date_end, statut";
    $sql .= " FROM ".MAIN_DB_PREFIX."accounting_fiscalyear";
    $sql .= " WHERE rowid = ".$id;

    dol_syslog(get_class($this)."::fetch", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      $obj = $this->db->fetch_object($result);

      $this->id = $obj->rowid;
      $this->ref = $obj->rowid;
      $this->date_start = $this->db->jdate($obj->date_start);
      $this->date_end = $this->db->jdate($obj->date_end);
      $this->label = $obj->label;
      $this->statut     = $obj->statut;

      return 1;
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
  }

  public function delete($id)
  {
    $this->db->begin();

    $sql = "DELETE FROM ".MAIN_DB_PREFIX."accounting_fiscalyear WHERE rowid = ".$id;

    dol_syslog(get_class($this)."::delete", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result)
    {
      $this->db->commit();
      return 1;
    } else {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }
  }

  public function getNomUrl($withpicto = 0, $notooltip = 0, $save_lastsearch_value = -1)
  {
    global $conf, $langs, $user;

    if (empty($this->ref)) $this->ref = $this->id;

    if (!empty($conf->dol_no_mouse_hover)) $notooltip = 1; // Force disable tooltips

    $result = '';

    $url = DOL_URL_ROOT.'/accountancy/admin/fiscalyear_card.php?id='.$this->id;

    if (!$user->rights->accounting->fiscalyear->write)
      $option = 'nolink';

    if ($option !== 'nolink')
    {
      // Add param to save lastsearch_values or not
      $add_save_lastsearch_values = ($save_lastsearch_value == 1 ? 1 : 0);
      if ($save_lastsearch_value == -1 && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) $add_save_lastsearch_values = 1;
      if ($add_save_lastsearch_values) $url .= '&save_lastsearch_values=1';
    }

    if ($short) return $url;

    $label = '';

    if ($user->rights->accounting->fiscalyear->write) {
      $label = '<u>'.$langs->trans("FiscalPeriod").'</u>';
      $label .= '<br><b>'.$langs->trans('Ref').':</b> '.$this->id;
      if (isset($this->statut)) {
        $label .= '<br><b>'.$langs->trans("Status").":</b> ".$this->getLibStatut(5);
      }
    }

    $linkclose = '';
    if (empty($notooltip) && $user->rights->accounting->fiscalyear->write)
    {
      if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER))
      {
        $label = $langs->trans("FiscalYear");
        $linkclose .= ' alt="'.dol_escape_htmltag($label, 1).'"';
      }
      $linkclose .= ' title="'.dol_escape_htmltag($label, 1).'"';
      $linkclose .= ' class="classfortooltip"';
    }

    $linkstart = '<a href="'.$url.'"';
    $linkstart .= $linkclose.'>';
    $linkend = '</a>';

    if ($option === 'nolink') {
      $linkstart = '';
      $linkend = '';
    }

    $result .= $linkstart;
    if ($withpicto) $result .= img_object(($notooltip ? '' : $label), $this->picto, ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="'.(($withpicto != 2) ? 'paddingright ' : '').'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
    if ($withpicto != 2) $result .= $this->ref;
    $result .= $linkend;

    return $result;
  }

  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->statut, $mode);
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;

    if ($mode == 0)
    {
      return $langs->trans($this->statuts[$status]);
    } elseif ($mode == 1)
    {
      return $langs->trans($this->statuts_short[$status]);
    } elseif ($mode == 2)
    {
      if ($status == 0) return img_picto($langs->trans($this->statuts_short[$status]), 'statut4').' '.$langs->trans($this->statuts_short[$status]);
      elseif ($status == 1) return img_picto($langs->trans($this->statuts_short[$status]), 'statut8').' '.$langs->trans($this->statuts_short[$status]);
    } elseif ($mode == 3)
    {
      if ($status == 0 && !empty($this->statuts_short[$status])) return img_picto($langs->trans($this->statuts_short[$status]), 'statut4');
      elseif ($status == 1 && !empty($this->statuts_short[$status])) return img_picto($langs->trans($this->statuts_short[$status]), 'statut8');
    } elseif ($mode == 4)
    {
      if ($status == 0 && !empty($this->statuts_short[$status])) return img_picto($langs->trans($this->statuts_short[$status]), 'statut4').' '.$langs->trans($this->statuts[$status]);
      elseif ($status == 1 && !empty($this->statuts_short[$status])) return img_picto($langs->trans($this->statuts_short[$status]), 'statut8').' '.$langs->trans($this->statuts[$status]);
    } elseif ($mode == 5)
    {
      if ($status == 0 && !empty($this->statuts_short[$status])) return $langs->trans($this->statuts_short[$status]).' '.img_picto($langs->trans($this->statuts_short[$status]), 'statut4');
      elseif ($status == 1 && !empty($this->statuts_short[$status])) return $langs->trans($this->statuts_short[$status]).' '.img_picto($langs->trans($this->statuts_short[$status]), 'statut6');
    }
  }

  public function info($id)
  {
    $sql = 'SELECT fy.rowid, fy.datec, fy.fk_user_author, fy.fk_user_modif,';
    $sql .= ' fy.tms';
    $sql .= ' FROM '.MAIN_DB_PREFIX.'accounting_fiscalyear as fy';
    $sql .= ' WHERE fy.rowid = '.$id;

    dol_syslog(get_class($this)."::fetch info", LOG_DEBUG);
    $result = $this->db->query($sql);

    if ($result)
    {
      if ($this->db->num_rows($result))
      {
        $obj = $this->db->fetch_object($result);
        $this->id = $obj->rowid;
        if ($obj->fk_user_author)
        {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_author);
          $this->user_creation = $cuser;
        }
        if ($obj->fk_user_modif)
        {
          $muser = new User($this->db);
          $muser->fetch($obj->fk_user_modif);
          $this->user_modification = $muser;
        }
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->tms);
      }
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function getAccountancyEntriesByFiscalYear($datestart = '', $dateend = '')
  {
    global $conf;

    if (empty($datestart))
      $datestart = $this->date_start;
    if (empty($dateend))
      $dateend = $this->date_end;

    $sql = "SELECT count(DISTINCT piece_num) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."accounting_bookkeeping";
    $sql .= " WHERE entity IN (".getEntity('bookkeeping', 0).")";
    $sql .= " AND doc_date >= '".$this->db->idate($datestart)."' and doc_date <= '".$this->db->idate($dateend)."'";

    $resql = $this->db->query($sql);
    if ($resql)
    {
      $obj = $this->db->fetch_object($resql);
      $nb = $obj->nb;
    } else dol_print_error($this->db);

    return $nb;
  }

  public function getAccountancyMovementsByFiscalYear($datestart = '', $dateend = '')
  {
    global $conf;

    if (empty($datestart))
      $datestart = $this->date_start;
    if (empty($dateend))
      $dateend = $this->date_end;

    $sql = "SELECT count(rowid) as nb";
    $sql .= " FROM ".MAIN_DB_PREFIX."accounting_bookkeeping ";
    $sql .= " WHERE entity IN (".getEntity('bookkeeping', 0).")";
    $sql .= " AND doc_date >= '".$this->db->idate($datestart)."' and doc_date <= '".$this->db->idate($dateend)."'";

    $resql = $this->db->query($sql);
    if ($resql)
    {
      $obj = $this->db->fetch_object($resql);
      $nb = $obj->nb;
    } else dol_print_error($this->db);

    return $nb;
  }
}