accounting.lib.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2013-2014  Olivier Geffroy         <jeff@jeffinfo.com>
 * Copyright (C) 2013-2026  Alexandre Spangaro      <alexandre@inovea-conseil.com>
 * Copyright (C) 2014       Florian Henry           <florian.henry@open-concept.pro>
 * Copyright (C) 2019       Eric Seigne             <eric.seigne@cap-rel.fr>
 * Copyright (C) 2021-2026  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024   MDW           <mdeweerd@users.noreply.github.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/>.
 */
 
function is_empty($var, $allow_false = false, $allow_ws = false)
{
  if (is_null($var) || !isset($var) || ($allow_ws == false && trim($var) == "" && !is_bool($var)) || ($allow_false === false && $var === false) || (is_array($var) && empty($var))) {
    return true;
  }
  return false;
}
 
function accounting_prepare_head(AccountingAccount $object)
{
  global $langs, $conf;
 
  $h = 0;
  $head = array();
 
  $head[$h][0] = dolBuildUrl(DOL_URL_ROOT.'/accountancy/admin/card.php', ['id' => $object->id]);
  $head[$h][1] = $langs->trans("AccountAccounting");
  $head[$h][2] = 'card';
  $h++;
 
  // Show more tabs from modules
  // Entries must be declared in modules descriptor with line
  // $this->tabs = array('entity:+tabname:Title:@mymodule:/mymodule/mypage.php?id=__ID__'); to add new tab
  // $this->tabs = array('entity:-tabname); to remove a tab
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_account');
 
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_account', 'remove');
 
  return $head;
}
 
function accounting_transaction_prepare_head(BookKeeping $object, $mode = '', $type = '', $backtopage = '/accountancy/bookkeeping/listbyaccount.php')
{
  global $langs, $conf;
 
  $h = 0;
  $head = array();
 
  $head[$h][0] = dolBuildUrl(DOL_URL_ROOT.'/accountancy/bookkeeping/card.php', ['piece_num' => $object->piece_num, 'mode' => $mode, 'type' => $type, 'backtopage' => $backtopage]);
  $head[$h][1] = $langs->trans("Transaction");
  $head[$h][2] = 'transaction';
  $h++;
 
  // Show more tabs from modules
  // Entries must be declared in modules descriptor with line
  // $this->tabs = array('entity:+tabname:Title:@mymodule:/mymodule/mypage.php?id=__ID__'); to add new tab
  // $this->tabs = array('entity:-tabname); to remove a tab
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_transaction');
 
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_transaction', 'remove');
 
  return $head;
}
 
function accountingTransactionTemplatePrepareHead(BookkeepingTemplate $object)
{
  global $langs, $conf;
 
  $h = 0;
  $head = array();
 
  $head[$h][0] = dolBuildUrl(DOL_URL_ROOT.'/accountancy/admin/template/card.php', ['id' => $object->id]);
  $head[$h][1] = $langs->trans("BookkeepingTemplate");
  $head[$h][2] = 'card';
  $h++;
 
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_template_transaction');
 
  complete_head_from_modules($conf, $langs, $object, $head, $h, 'accounting_template_transaction', 'remove');
 
  return $head;
}
 
function clean_account($account)
{
  $account = rtrim($account, "0");
 
  return $account;
}
 
function length_accountg($account)
{
  if ($account < 0 || is_empty($account)) {
    return '';
  }
 
  if (getDolGlobalString('ACCOUNTING_MANAGE_ZERO')) {
    return $account;
  }
 
  $g = getDolGlobalInt('ACCOUNTING_LENGTH_GACCOUNT');
  if (!is_empty($g)) {
    // Clean parameters
    $i = strlen($account);
 
    if ($i >= 1) {
      while ($i < $g) {
        $account .= '0';
        $i++;
      }
 
      return $account;
    } else {
      return $account;
    }
  } else {
    return $account;
  }
}
 
function length_accounta($accounta)
{
  global $conf;
 
  if ($accounta < 0 || is_empty($accounta)) {
    return '';
  }
 
  if (getDolGlobalString('ACCOUNTING_MANAGE_ZERO')) {
    return $accounta;
  }
 
  $a = getDolGlobalInt('ACCOUNTING_LENGTH_AACCOUNT');
  if (!is_empty($a)) {
    // Clean parameters
    $i = strlen($accounta);
 
    if ($i >= 1) {
      while ($i < $a) {
        $accounta .= '0';
        $i++;
      }
 
      return $accounta;
    } else {
      return $accounta;
    }
  } else {
    return $accounta;
  }
}
 
function checkGeneralAccountAllowsAuxiliary($db, $general_account, $auxiliary_account, $general_account_id = 0)
{
  global $conf;
 
  if (empty($auxiliary_account)) return true; // No check needed if no auxiliary account used
 
  // Build SQL to get general account info based on rowid or account number
  $sql = "SELECT rowid, account_number, centralized";
  $sql .= " FROM ".MAIN_DB_PREFIX."accounting_account";
  $sql .= " WHERE";
  if ($general_account_id > 0) {
    $sql .= " rowid = ".((int) $general_account_id);
  } else {
    $sql .= " account_number = '".$db->escape($general_account)."'";
  }
  $sql .= " AND entity = ". ((int) $conf->entity);
  $sql .= " AND fk_pcg_version IN (SELECT pcg_version FROM ".MAIN_DB_PREFIX."accounting_system WHERE rowid = ".((int) getDolGlobalInt('CHARTOFACCOUNTS')).")";
 
  $resql = $db->query($sql);
  if ($resql) {
    $obj = $db->fetch_object($resql);
    if ($obj && empty($obj->centralized)) {
      // Not a centralized account -> not allowed to use auxiliary
      return false;
    }
  }
 
  return true;
}
 
function journalHead($nom, $variant, $period, $periodlink, $description, $builddate, $exportlink = '', $moreparam = array(), $calcmode = '', $varlink = '', $moreoptions = array())
{
  global $langs;
 
  print "\n\n<!-- start banner journal -->\n";
 
  if (!is_empty($varlink)) {
    $varlink = '?'.$varlink;
  }
 
  $head = array();
  $h = 0;
  $head[$h][0] = $_SERVER["PHP_SELF"].$varlink;
  $head[$h][1] = $langs->trans("Journalization");
  $head[$h][2] = 'journal';
 
  print '<form method="POST" action="'.$_SERVER["PHP_SELF"].$varlink.'">';
  print '<input type="hidden" name="token" value="'.newToken().'">';
 
  print dol_get_fiche_head($head, 'journal');
 
  foreach ($moreparam as $key => $value) {
    print '<input type="hidden" name="'.$key.'" value="'.$value.'">';
  }
  print '<table class="border centpercent tableforfield">';
 
  // Title
  print '<tr>';
  print '<td class="titlefieldcreate">'.$langs->trans("Name").'</td>';
  print '<td colspan="3">';
  print $nom;
  print '</td>';
  print '</tr>';
 
  // Calculation mode
  if ($calcmode) {
    print '<tr>';
    print '<td>'.$langs->trans("CalculationMode").'</td>';
    if (!$variant) {
      print '<td colspan="3">';
    } else {
      print '<td>';
    }
    print $calcmode;
    if ($variant) {
      print '</td><td colspan="2">'.$variant;
    }
    print '</td>';
    print '</tr>';
  }
 
  // Period of report
  print '<tr>';
  print '<td>'.$langs->trans("ReportPeriod").'</td>';
  if (!$periodlink) {
    print '<td colspan="3">';
  } else {
    print '<td>';
  }
  if ($period) {
    print $period;
  }
  if ($periodlink) {
    print '</td><td colspan="2">'.$periodlink;
  }
  print '</td>';
  print '</tr>';
 
  // Line description
  print '<tr>';
  print '<td>'.$langs->trans("ReportDescription").'</td>';
  print '<td colspan="3">'.$description.'</td>';
  print '</tr>';
 
 
  // more options
  foreach ($moreoptions as $key => $value) {
    print '<tr>';
    print '<td>'.$langs->trans($key).'</td>';
    print '<td colspan="3">'.$value.'</td>';
    print '</tr>';
  }
 
  print '</table>';
 
  print dol_get_fiche_end();
 
  print '<div class="center"><input type="submit" class="button" name="submit" value="'.$langs->trans("Refresh").'"></div>';
 
  print '</form>';
 
  print "\n<!-- end banner journal -->\n\n";
}
 
function getDefaultDatesForTransfer()
{
  global $db;
 
  $date_start = '';
  $date_end = '';
  $pastmonth = 0;
  $pastmonthyear = 0;
 
  // Period by default on transfer (0: previous month | 1: current month | 2: fiscal year)
  $periodbydefaultontransfer = getDolGlobalInt('ACCOUNTING_DEFAULT_PERIOD_ON_TRANSFER', 0);
  if ($periodbydefaultontransfer == 2) {  // fiscal year
    $sql = "SELECT date_start, date_end FROM ".MAIN_DB_PREFIX."accounting_fiscalyear";
    $sql .= " WHERE date_start < '".$db->idate(dol_now())."' AND date_end > '".$db->idate(dol_now())."'";
    $sql .= $db->plimit(1);
    $res = $db->query($sql);
    if ($db->num_rows($res) > 0) {
      $obj = $db->fetch_object($res);
 
      $date_start = $db->jdate($obj->date_start);
      $date_end = dol_get_last_hour($db->jdate($obj->date_end));
    } else {
      $month_start = getDolGlobalInt('SOCIETE_FISCAL_MONTH_START', 1);
      $year_start = (int) dol_print_date(dol_now(), '%Y');
      if ($month_start > (int) dol_print_date(dol_now(), '%m')) {
        $year_start -= 1;
      }
      $year_end = $year_start + 1;
      $month_end = $month_start - 1;
      if ($month_end < 1) {
        $month_end = 12;
        $year_end--;
      }
      $date_start = dol_mktime(0, 0, 0, $month_start, 1, $year_start);
      $lastday = dol_get_last_day($year_end, $month_end);
      $date_end = dol_mktime(23, 59, 59, $month_end, (int) dol_print_date($lastday, '%d'), $year_end);
    }
  } elseif ($periodbydefaultontransfer == 1) {  // current month
    $year_current = (int) dol_print_date(dol_now('gmt'), "%Y", 'gmt');
    $pastmonth = (int) dol_print_date(dol_now('gmt'), '%m', 'gmt');
    $pastmonthyear = $year_current;
    if ($pastmonth == 0) {
      $pastmonth = 12;
      $pastmonthyear--;
    }
  } else {  // previous month
    $year_current = (int) dol_print_date(dol_now('gmt'), "%Y", 'gmt');
    $pastmonth = (int) dol_print_date(dol_now('gmt'), '%m', 'gmt') - 1;
    $pastmonthyear = $year_current;
    if ($pastmonth == 0) {
      $pastmonth = 12;
      $pastmonthyear--;
    }
  }
  return array(
    'date_start' => $date_start,
    'date_end' => $date_end,
    'pastmonthyear' => $pastmonthyear,
    'pastmonth' => $pastmonth
  );
}
 
function getCurrentPeriodOfFiscalYear($db, $conf, $from_time = null, $gm = 'tzserver', $withenddateonly = 1)
{
  $now = dol_now();
  $now_arr = dol_getdate($now);
  if ($from_time === null) {
    $from_time = $now;
  } else {
    $now_arr = dol_getdate($from_time);
  }
 
  include_once DOL_DOCUMENT_ROOT.'/core/lib/date.lib.php';
 
  // Take the first period found
  $sql  = "SELECT date_start, date_end FROM ".$db->prefix()."accounting_fiscalyear";
  $sql .= " WHERE date_start <= '".$db->idate($from_time, $gm)."'";
  if ($withenddateonly) {
    $sql .= " AND (date_end >= '".$db->idate($from_time, $gm)."')";
  } else {
    $sql .= " AND (date_end >= '".$db->idate($from_time, $gm)."' OR date_end IS NULL)";
  }
  //$sql .= " AND statut = 0"
  $sql .= " AND entity IN (".getEntity('accounting_fiscalyear').")";
  $sql .= $db->order('date_start', 'DESC');
  $sql .= $db->plimit(1);
 
  $res = $db->query($sql);
 
  if ($db->num_rows($res) > 0) {
    // If found
    $obj = $db->fetch_object($res);
 
    $date_start = $db->jdate($obj->date_start, $gm);
    $date_end = dol_get_last_hour($db->jdate($obj->date_end, $gm), $gm);
  } else {
    // If not found, we generate a period
    $month_start = 1;
    $conf_fiscal_month_start = getDolGlobalInt('SOCIETE_FISCAL_MONTH_START');
    if ($conf_fiscal_month_start >= 1 && $conf_fiscal_month_start <= 12) {
      $month_start = $conf_fiscal_month_start;
    }
    $year_start = $now_arr['year'];
    if ($conf_fiscal_month_start > $now_arr['mon']) {
      $year_start -= 1;
    }
    $year_end = $year_start + 1;
    $month_end = $month_start - 1;
    if ($month_end < 1) {
      $month_end = 12;
      $year_end--;
    }
    $date_start = dol_mktime(0, 0, 0, $month_start, 1, $year_start, $gm);
    $date_end = dol_get_last_day($year_end, $month_end, $gm);
  }
 
  return array(
    'date_start' => $date_start,
    'date_end' => $date_end,
  );
}
 
function getNextFiscalYear($db, $after_date, $gm = 'tzserver')
{
  // Find the fiscal year that starts strictly after the given date
  $sql = "SELECT date_start, date_end FROM ".$db->prefix()."accounting_fiscalyear";
  $sql .= " WHERE date_start > '".$db->idate($after_date, $gm)."'";
  $sql .= " AND entity IN (".getEntity('accounting_fiscalyear').")";
  $sql .= $db->order('date_start', 'ASC');  // Get the first one (earliest)
  $sql .= $db->plimit(1);
 
  $res = $db->query($sql);
 
  if ($res && $db->num_rows($res) > 0) {
    $obj = $db->fetch_object($res);
 
    $date_start = $db->jdate($obj->date_start, $gm);
    $date_end = $db->jdate($obj->date_end, $gm);  // Without dol_get_last_hour to avoid the bug
 
    return array(
      'date_start' => $date_start,
      'date_end' => $date_end,
    );
  }
 
  return null;  // No next fiscal year found
}