webportalinvoice.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2023-2024  Laurent Destailleur   <eldy@users.sourceforge.net>
 * Copyright (C) 2023-2024  Lionel Vessiller    <lvessiller@easya.solutions>
 * Copyright (C) 2024   MDW             <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Frédéric France             <frederic.france@free.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/>.
 */
 
// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT . '/compta/facture/class/facture.class.php';
 
class WebPortalInvoice extends Facture
{
  public $module = 'webportal';
 
  const ARRAY_STATUS_LABEL = array(
    Facture::STATUS_DRAFT => 'BillShortStatusDraft',
    Facture::STATUS_VALIDATED => 'BillShortStatusNotPaid',
    Facture::STATUS_CLOSED => 'BillShortStatusPaid',
    Facture::STATUS_ABANDONED => 'BillShortStatusCanceled',
  );
 
  protected $invoice_static = null;
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 1,),
    'entity' => array('type' => 'integer', 'label' => 'Entity', 'default' => '1', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 20, 'index' => 1,),
    'ref' => array('type' => 'varchar(30)', 'label' => 'Ref', 'enabled' => 1, 'visible' => 2, 'notnull' => 1, 'showoncombobox' => 1, 'position' => 5,),
    'type' => array('type' => 'smallint(6)', 'label' => 'Type', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 15,),
    'datef' => array('type' => 'date', 'label' => 'DateInvoice', 'enabled' => 1, 'visible' => 2, 'position' => 20,),
    'date_lim_reglement' => array('type' => 'date', 'label' => 'DateDue', 'enabled' => 1, 'visible' => 2, 'position' => 25,),
    'paye' => array('type' => 'smallint(6)', 'label' => 'InvoicePaidCompletely', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 80,),
    'total_ht' => array('type' => 'price', 'label' => 'AmountHT', 'enabled' => 1, 'visible' => 2, 'position' => 95, 'isameasure' => 1,),
    'total_tva' => array('type' => 'price', 'label' => 'AmountVAT', 'enabled' => 1, 'visible' => 2, 'position' => 100, 'isameasure' => 1,),
    'total_ttc' => array('type' => 'price', 'label' => 'AmountTTC', 'enabled' => 1, 'visible' => 2, 'position' => 130, 'isameasure' => 1,),
    'multicurrency_total_ht' => array('type' => 'price', 'label' => 'MulticurrencyAmountHT', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 290, 'isameasure' => 1,),
    'multicurrency_total_tva' => array('type' => 'price', 'label' => 'MulticurrencyAmountVAT', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 291, 'isameasure' => 1,),
    'multicurrency_total_ttc' => array('type' => 'price', 'label' => 'MulticurrencyAmountTTC', 'enabled' => 'isModEnabled("multicurrency")', 'visible' => -2, 'position' => 292, 'isameasure' => 1,),
    'fk_statut' => array('type' => 'smallint(6)', 'label' => 'Status', 'enabled' => 1, 'visible' => 2, 'notnull' => 1, 'position' => 1000, 'arrayofkeyval' => self::ARRAY_STATUS_LABEL,),
  );
  //public $rowid;
  //public $ref;
  public $datef;
  //public $date_lim_reglement;
  //public $total_ht;
  //public $total_tva;
  //public $total_ttc;
  //public $multicurrency_total_ht;
  //public $multicurrency_total_tva;
  //public $multicurrency_total_ttc;
 
  public $fk_statut;
  // END MODULEBUILDER PROPERTIES
 
 
  protected function getInvoiceStatic()
  {
    if (!$this->invoice_static) {
      $this->invoice_static = new Facture($this->db);
    }
 
    return $this->invoice_static;
  }
 
  public function __construct(DoliDB $db)
  {
    $this->db = $db;
 
    $this->isextrafieldmanaged = 0;
 
    $this->getInvoiceStatic();
  }
 
  public function getTooltipContentArray($params)
  {
    global $langs;
 
    $langs->load('bills');
 
    $datas = [];
 
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $max = 0, $short = 0, $moretitle = '', $notooltip = 0, $addlinktonotes = 0, $save_lastsearch_value = -1, $target = '')
  {
    global $langs, $conf;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
 
    $url = '';
    $option = 'nolink';
 
    if ($short) {
      return $url;
    }
 
    $picto = $this->picto;
    if ($this->type == self::TYPE_REPLACEMENT) {
      $picto .= 'r'; // Replacement invoice
    }
    if ($this->type == self::TYPE_CREDIT_NOTE) {
      $picto .= 'a'; // Credit note
    }
    if ($this->type == self::TYPE_DEPOSIT) {
      $picto .= 'd'; // Deposit invoice
    }
    $params = [
      'id' => $this->id,
      'objecttype' => $this->element,
      'moretitle' => $moretitle,
      'option' => $option,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
      $classfortooltip = 'classforajaxtooltip';
      $dataparams = ' data-params="' . dol_escape_htmltag(json_encode($params)) . '"';
      $label = '';
    } else {
      $label = implode($this->getTooltipContentArray($params));
    }
 
    $linkclose = ($target ? ' target="' . $target . '"' : '');
 
    $linkstart = '<a href="' . $url . '"';
    $linkstart .= $linkclose . '>';
    $linkend = '</a>';
 
    if ($option == 'nolink') {
      $linkstart = '';
      $linkend = '';
    }
 
    $result .= $linkstart;
    if ($withpicto) {
      $result .= img_object(($notooltip ? '' : $label), $picto, ($notooltip ? (($withpicto != 2) ? 'class="paddingright"' : '') : $dataparams . ' class="' . (($withpicto != 2) ? 'paddingright ' : '') . $classfortooltip . '"'), 0, 0, $notooltip ? 0 : 1);
    }
    if ($withpicto != 2) {
      $result .= ($max ? dol_trunc($this->ref, $max) : $this->ref);
    }
    $result .= $linkend;
 
    global $action, $hookmanager;
    $hookmanager->initHooks(array('invoicedao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result, 'notooltip' => $notooltip, 'addlinktonotes' => $addlinktonotes, 'save_lastsearch_value' => $save_lastsearch_value, 'target' => $target);
    $reshook = $hookmanager->executeHooks('getNomUrl', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if ($reshook > 0) {
      $result = $hookmanager->resPrint;
    } else {
      $result .= $hookmanager->resPrint;
    }
 
    return $result;
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    //$return .= '<i class="fa fa-dol-action"></i>'; // Can be image
    $return .= '</span>';
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">' . (method_exists($this, 'getNomUrl') ? $this->getNomUrl(1) : $this->ref) . '</span>';
    $return .= '<input id="cb' . $this->id . '" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="' . $this->id . '"' . ($selected ? ' checked="checked"' : '') . '>';
    if (property_exists($this, 'socid')) {
      $return .= '<br><span class="info-box-label">' . $this->socid . '</span>';
    }
    if (property_exists($this, 'fk_user_author')) {
      $return .= '<br><span class="info-box-label">' . $this->fk_user_author . '</span>';
    }
    if (method_exists($this, 'getLibStatut')) {
      $return .= '<br><div class="info-box-status margintoponly">' . $this->getLibStatut(3) . '</div>';
    }
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
 
    return $return;
  }
 
  public function getLabelStatus($mode = 0)
  {
    return $this->LibStatut($this->paye, $this->fk_statut, $mode, -1, $this->type);
  }
 
  public function getLibStatut($mode = 0, $alreadypaid = -1)
  {
    return $this->LibStatut($this->paye, $this->fk_statut, $mode, $alreadypaid, $this->type);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
 
  public function LibStatut($paye, $status, $mode = 0, $alreadypaid = -1, $type = -1)
  {
    // phpcs:enable
    return $this->getInvoiceStatic()->LibStatut($paye, $status, $mode, $alreadypaid, $type);
  }
}