loan.lib.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2014-2016  Alexandre Spangaro  <aspangaro@open-dsi.fr>
 * Copyright (C) 2015-2024  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2020       Maxime DEMAREST     <maxime@indelog.fr>
 * Copyright (C) 2024-2025  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 loan_prepare_head($object)
{
  global $db, $langs, $conf;
 
  $tab = 0;
  $head = array();
 
  $head[$tab][0] = DOL_URL_ROOT.'/loan/card.php?id='.$object->id;
  $head[$tab][1] = $langs->trans('Card');
  $head[$tab][2] = 'card';
  $tab++;
 
  $head[$tab][0] = DOL_URL_ROOT.'/loan/schedule.php?loanid='.$object->id;
  $head[$tab][1] = $langs->trans('FinancialCommitment');
  $head[$tab][2] = 'FinancialCommitment';
  $tab++;
 
  // 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, $tab, 'loan', 'add', 'core');
 
  require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
  require_once DOL_DOCUMENT_ROOT.'/core/class/link.class.php';
  $upload_dir = $conf->loan->dir_output."/".dol_sanitizeFileName($object->ref);
  $nbFiles = count(dol_dir_list($upload_dir, 'files', 0, '', '(\.meta|_preview.*\.png)$'));
  $nbLinks = Link::count($db, $object->element, $object->id);
  $head[$tab][0] = DOL_URL_ROOT.'/loan/document.php?id='.$object->id;
  $head[$tab][1] = $langs->trans("Documents");
  if (($nbFiles + $nbLinks) > 0) {
    $head[$tab][1] .= '<span class="badge marginleftonlyshort">'.($nbFiles + $nbLinks).'</span>';
  }
  $head[$tab][2] = 'documents';
  $tab++;
 
  if (!getDolGlobalString('MAIN_DISABLE_NOTES_TAB')) {
    $nbNote = (empty($object->note_private) ? 0 : 1) + (empty($object->note_public) ? 0 : 1);
    $head[$tab][0] = DOL_URL_ROOT."/loan/note.php?id=".$object->id;
    $head[$tab][1] = $langs->trans("Notes");
    if ($nbNote > 0) {
      $head[$tab][1] .= '<span class="badge marginleftonlyshort">'.$nbNote.'</span>';
    }
    $head[$tab][2] = 'note';
    $tab++;
  }
 
  $head[$tab][0] = DOL_URL_ROOT.'/loan/info.php?id='.$object->id;
  $head[$tab][1] = $langs->trans("Info");
  $head[$tab][2] = 'info';
  $tab++;
 
  complete_head_from_modules($conf, $langs, $object, $head, $tab, 'loan', 'add', 'external');
 
  complete_head_from_modules($conf, $langs, $object, $head, $tab, 'loan', 'remove');
 
  return $head;
}
 
function loanCalcMonthlyPayment($mens, $capital, $rate, $numactualloadterm, $nbterm, $amort = null, $source = 'mens', $grace_period = 0, $int = null)
{
  global $conf, $db;
  require_once DOL_DOCUMENT_ROOT.'/loan/class/loanschedule.class.php';
  $object = new LoanSchedule($db);
  $output = array();
 
  // Sanitize data in case of
  $mens = (float) price2num($mens);
  $capital = (float) price2num($capital);
  $rate = (float) price2num($rate);
  $numactualloadterm = ((int) $numactualloadterm);
  $nbterm = ((int) $nbterm);
  $grace_period = ((int) $grace_period);
  $amort = ($amort !== null && $amort !== '') ? (float) price2num($amort) : null;
  $int = ($int !== null && $int !== '') ? (float) price2num($int) : null;
 
  if ($grace_period > 0 && $numactualloadterm <= $grace_period) {
    $amort = 0.0;
    $int = ($int !== null && $int > 0) ? $int : round((float) $capital * ((float) $rate / 12), 2, PHP_ROUND_HALF_UP);
    $mens = $int;
    $cap_rest = $capital;
  } elseif ($source === 'amort') {
    $amort = ($amort !== null) ? $amort : 0.0;
    $int = ($int !== null && $int > 0) ? $int : round((float) $capital * ((float) $rate / 12), 2, PHP_ROUND_HALF_UP);
    $mens = round((float) $amort + (float) $int, 2, PHP_ROUND_HALF_UP);
    $cap_rest = round((float) $capital - (float) $amort, 2, PHP_ROUND_HALF_UP);
  } elseif ($source === 'interet') {
    $int = ($int !== null) ? $int : round((float) $capital * ((float) $rate / 12), 2, PHP_ROUND_HALF_UP);
    $amort = ($amort !== null) ? $amort : 0.0;
    $mens = round((float) $amort + (float) $int, 2, PHP_ROUND_HALF_UP);
    $cap_rest = round((float) $capital - (float) $amort, 2, PHP_ROUND_HALF_UP);
  } else {
    // source === 'mens'
    if ($amort !== null && $amort == 0) {
      // Zero capital amortization: payment is interest/fees and capital stays intact
      $amort = 0.0;
      $int = $mens;
      $cap_rest = $capital;
    } else {
      $int = ($int !== null && $int > 0) ? $int : round((float) $capital * ((float) $rate / 12), 2, PHP_ROUND_HALF_UP);
      $amort = round((float) $mens - (float) $int, 2, PHP_ROUND_HALF_UP);
      if ($amort < 0) {
        $amort = 0.0;
        $int = $mens;
        $cap_rest = $capital;
      } else {
        $cap_rest = round((float) $capital - (float) $amort, 2, PHP_ROUND_HALF_UP);
      }
    }
  }
 
  $output[$numactualloadterm] = array(
    'cap_rest' => $cap_rest,
    'cap_rest_str' => price($cap_rest, 0, '', 1, -1, -1, $conf->currency),
    'interet' => $int,
    'interet_str' => price($int, 0, '', 1, -1, -1, $conf->currency),
    'amort' => price($amort),
    'amort_num' => (float) $amort,
    'mens' => price($mens),
    'mens_num' => (float) $mens,
  );
 
  $numactualloadterm++;
  $capital = $cap_rest;
  while ($numactualloadterm <= $nbterm) {
    if ($grace_period > 0 && $numactualloadterm <= $grace_period) {
      $amort = 0.0;
      $int = ((float) $capital * ((float) $rate / 12));
      $int = round($int, 2, PHP_ROUND_HALF_UP);
      $mens = $int;
      $cap_rest = $capital;
    } else {
      $mens = round($object->calcMonthlyPayments($capital, (float) $rate, $nbterm - $numactualloadterm + 1), 2, PHP_ROUND_HALF_UP);
 
      $int = ($capital * ((float) $rate / 12));
      $int = round($int, 2, PHP_ROUND_HALF_UP);
      $amort = round($mens - $int, 2, PHP_ROUND_HALF_UP);
      $cap_rest = round($capital - $amort, 2, PHP_ROUND_HALF_UP);
 
      // Adjust rounding difference on the last installment if small remainder
      if ($numactualloadterm == $nbterm && abs($cap_rest) <= 0.05 && $capital > 0) {
        $amort = $capital;
        $cap_rest = 0.0;
        $mens = round($amort + $int, 2, PHP_ROUND_HALF_UP);
      }
    }
 
    $output[$numactualloadterm] = array(
      'cap_rest' => $cap_rest,
      'cap_rest_str' => price($cap_rest, 0, '', 1, -1, -1, $conf->currency),
      'interet' => $int,
      'interet_str' => price($int, 0, '', 1, -1, -1, $conf->currency),
      'amort' => price($amort),
      'amort_num' => (float) $amort,
      'mens' => price($mens),
      'mens_num' => (float) $mens,
    );
    $capital = $cap_rest;
    $numactualloadterm++;
  }
 
  return $output;
}