bookkeepingtemplate.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2024       AWeerWolf
 * Copyright (C) 2026       Alexandre Spangaro    <alexandre@inovea-conseil.com>
 * Copyright (C) 2026   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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT . '/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT . '/accountancy/class/bookkeepingtemplateline.class.php';
 
class BookkeepingTemplate extends CommonObject
{
  public $module = 'accountancy';
 
  public $element = 'accounting_transaction_template';
 
  public $table_element = 'accounting_transaction_template';
 
  public $ismultientitymanaged = 1;
 
  public $isextrafieldmanaged = 1;
 
  public $picto = 'fa-list';
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    "rowid" => array("type" => "integer", "label" => "TechnicalID", "enabled" => 1, 'position' => 1, 'notnull' => 1, "visible" => 0, "noteditable" => 1, "index" => 1, "css" => "left", "comment" => "Id"),
    "entity" => array("type" => "integer", "label" => "Entity", "enabled" => 1, 'position' => 5, 'notnull' => 1, "visible" => 0, "index" => 1, "default" => '1'),
    "code" => array("type" => "varchar(128)", "label" => "Code", "enabled" => 1, 'position' => 10, 'notnull' => 1, "visible" => 1, "index" => 1, "searchall" => 1, "css" => "minwidth300", "help" => "UniqueCodeForTemplate"),
    "label" => array("type" => "varchar(255)", "label" => "Label", "enabled" => 1, 'position' => 20, 'notnull' => 0, "visible" => 1, "css" => "minwidth300"),
    "date_creation" => array("type" => "datetime", "label" => "DateCreation", "enabled" => 1, 'position' => 500, 'notnull' => 1, "visible" => -2),
    "tms" => array("type" => "timestamp", "label" => "DateModification", "enabled" => 1, 'position' => 501, 'notnull' => 0, "visible" => -2),
    "fk_user_creat" => array("type" => "integer:User:user/class/user.class.php", "label" => "UserAuthor", "picto" => "user", "enabled" => 1, 'position' => 510, 'notnull' => 1, "visible" => "-2", "csslist" => "tdoverflowmax150"),
    "fk_user_modif" => array("type" => "integer:User:user/class/user.class.php", "label" => "UserModif", "picto" => "user", "enabled" => 1, 'position' => 511, 'notnull' => -1, "visible" => "-2", "csslist" => "tdoverflowmax150"),
    "import_key" => array("type" => "varchar(14)", "label" => "ImportId", "enabled" => 1, 'position' => 1000, 'notnull' => -1, "visible" => -2),
  );
  // END MODULEBUILDER PROPERTIES
 
  public $rowid;
 
  public $entity;
 
  public $code;
 
  public $label;
 
  public $date_creation;
 
  public $tms;
 
  public $fk_user_creat;
 
  public $fk_user_modif;
 
  public $import_key;
 
  public $table_element_line = 'accounting_transaction_template_det';
 
  public $lines = array();
 
 
  public function __construct(DoliDB $db)
  {
    global $conf, $langs;
 
    $this->db = $db;
 
    if (!getDolGlobalInt('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'], $this->fields['code']) && is_array($this->fields['rowid'])) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
      $this->fields['entity']['enabled'] = 0;
    }
 
    // Unset fields that are disabled
    foreach ($this->fields as $key => $val) {
      if (isset($val['enabled']) && empty($val['enabled'])) {
        unset($this->fields[$key]);
      }
    }
 
    // Translate some data of arrayofkeyval
    if (is_object($langs)) {
      foreach ($this->fields as $key => $val) {
        if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
          foreach ($val['arrayofkeyval'] as $key2 => $val2) {
            $this->fields[$key]['arrayofkeyval'][$key2] = (string) $langs->trans($val2);
          }
        }
      }
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    $resultcreate = $this->createCommon($user, $notrigger);
    return $resultcreate;
  }
 
  public function createFromClone(User $user, $fromid)
  {
    global $langs, $extrafields;
    $error = 0;
 
    dol_syslog(__METHOD__, LOG_DEBUG);
 
    $object = new self($this->db);
 
    $this->db->begin();
 
    // Load source object
    $result = $object->fetchCommon($fromid);
    if ($result > 0 && !empty($object->table_element_line)) {
      $object->fetchLines();
    }
 
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
 
    // Clear fields
    $object->code = "COPY_" . $object->code;
    $object->label = $langs->trans("CopyOf") . " " . $object->label;
    $object->date_creation = dol_now();
 
    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
 
    if ($result < 0) {
      $error++;
      $this->setErrorsFromObject($object);
    }
 
    if (!$error) {
      // Copy Attached Lines
      $this->getLinesArray();
      foreach ($this->lines as $linetoclone) {
        // Clear some info
        unset($linetoclone->id);
        unset($linetoclone->fk_user_creat);
        $linetoclone->fk_transaction_template = $object->id;
 
        // Save in DB
        $linetoclone->createCommon($user);
      }
    }
 
    unset($object->context['createfromclone']);
 
    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
  public function fetch($id, $code = null, $noextrafields = 0, $nolines = 0)
  {
    $result = $this->fetchCommon($id, $code, '', $noextrafields);
    if ($result > 0 && !empty($this->table_element_line) && empty($nolines)) {
      $this->fetchLines($noextrafields);
    }
    return $result;
  }
 
  public function fetchLines($noextrafields = 0)
  {
    $this->lines = array();
 
    $objectline = new BookkeepingTemplateLine($this->db);
    $result = $objectline->fetchAll('ASC', 'rowid', 0, 0, array('customsql' => 'fk_transaction_template = ' . ((int) $this->id)));
 
    if (is_numeric($result)) {
      $this->setErrorsFromObject($objectline);
      return $result;
    } else {
      $this->lines = $result;
      return $this->lines;
    }
  }
 
  public function update(User $user, $notrigger = 0)
  {
    return $this->updateCommon($user, $notrigger);
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    global $conf, $langs;
 
    $error = 0;
 
    $this->db->begin();
 
    // Delete the Lines first
    $obj_line = new BookkeepingTemplateLine($this->db);
 
    $sql = "DELETE FROM ".$this->db->prefix().$obj_line->table_element;
    $sql .= " WHERE fk_transaction_template = ".((int) $this->id);
 
    dol_syslog(get_class($this)."::delete sql=".$sql, LOG_DEBUG);
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = $this->db->lasterror();
      $error++;
      dol_syslog(get_class($this)."::delete error deleting lines: ".$this->db->lasterror(), LOG_ERR);
    }
 
    if (empty($error)) {
      // Call trigger
      if (!$notrigger) {
        $result = $this->call_trigger(strtoupper(get_class($this)).'_DELETE', $user);
        if ($result < 0) {
          $error++;
        }
      }
    }
 
    if (empty($error)) {
      // Delete main object
      $sql = "DELETE FROM ".$this->db->prefix().$this->table_element;
      $sql .= " WHERE rowid = ".((int) $this->id);
 
      dol_syslog(get_class($this)."::delete sql=".$sql, LOG_DEBUG);
 
      $resql = $this->db->query($sql);
      if (!$resql) {
        $this->errors[] = $this->db->lasterror();
        $this->error = $this->db->lasterror();
        $error++;
        dol_syslog(get_class($this)."::delete error deleting main object: ".$this->db->lasterror(), LOG_ERR);
      }
    }
 
    // Commit or rollback
    if (empty($error)) {
      $this->db->commit();
      return 1;
    } else {
      $this->error = implode(', ', $this->errors);
      $this->db->rollback();
      return -1;
    }
  }
 
  public function deleteLine(User $user, $idline, $notrigger = 0)
  {
    $tmpline = new BookkeepingTemplateLine($this->db);
    if ($tmpline->fetch($idline) > 0) {
      return $tmpline->delete($user);
    }
 
    return -1;
  }
 
  public function getLinesArray()
  {
    $this->lines = array();
 
    $objectline = new BookkeepingTemplateLine($this->db);
    $result = $objectline->fetchAll('ASC', 'rowid', 0, 0, array('customsql' => 'fk_transaction_template = ' . ((int) $this->id)));
 
    if (is_numeric($result)) {
      $this->setErrorsFromObject($objectline);
      return $result;
    } else {
      $this->lines = $result;
      return $this->lines;
    }
  }
 
  public function getNextNumRef()
  {
    global $langs, $conf;
    $langs->load("accountancy");
 
    // Standard numbering - Generate a code based on timestamp
    $code = 'TPL' . dol_print_date(dol_now(), '%Y%m%d%H%M%S');
 
    return $code;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1;
    }
 
    $result = '';
 
    $label = img_picto('', $this->picto) . ' <u>' . $langs->trans("BookkeepingTemplate") . '</u>';
    if (isset($this->code)) {
      $label .= '<br><b>' . $langs->trans('Code') . ':</b> ' . $this->code;
    }
    if (isset($this->label)) {
      $label .= '<br><b>' . $langs->trans('Label') . ':</b> ' . $this->label;
    }
 
    $url = DOL_URL_ROOT . '/accountancy/admin/template/card.php?id=' . $this->id;
 
    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 && isset($_SERVER["PHP_SELF"]) && preg_match('/list\.php/', $_SERVER["PHP_SELF"])) {
        $add_save_lastsearch_values = 1;
      }
      if ($add_save_lastsearch_values) {
        $url .= '&save_lastsearch_values=1';
      }
    }
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowBookkeepingTemplate");
        $linkclose .= ' alt="' . dol_escape_htmltag($label, 1) . '"';
      }
      $linkclose .= ' title="' . dol_escape_htmltag($label, 1) . '"';
      $linkclose .= ' class="classfortooltip' . ($morecss ? ' ' . $morecss : '') . '"';
    } else {
      $linkclose = ($morecss ? ' class="' . $morecss . '"' : '');
    }
 
    if ($option == 'nolink') {
      $linkstart = '<span';
    } else {
      $linkstart = '<a href="' . $url . '"';
    }
    $linkstart .= $linkclose . '>';
    if ($option == 'nolink') {
      $linkend = '</span>';
    } else {
      $linkend = '</a>';
    }
 
    $result .= $linkstart;
 
    if ($withpicto) {
      $result .= img_object(($notooltip ? '' : $label), ($this->picto ? $this->picto : 'generic'), ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : 'class="' . (($withpicto != 2) ? 'paddingright ' : '') . 'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
    }
 
    if ($withpicto != 2) {
      $result .= $this->code;
    }
 
    $result .= $linkend;
 
    return $result;
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut(1, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
 
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    return '';
  }
}