commonobjectline.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2006-2008  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2012       Cedric Salvador         <csalvador@gpcsolutions.fr>
 * Copyright (C) 2024-2026  MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2026   Lionel Vessiller    <lvessiller@open-dsi.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';
 
 
abstract class CommonObjectLine extends CommonObject
{
  public $parent_element = '';
 
  public $fk_parent_attribute = '';
 
  public $id;
 
  public $rowid;
 
  public $picto = 'line';
 
  public $fk_unit;
 
  public $date_debut_prevue;
  public $date_debut_reel;
  public $date_fin_prevue;
  public $date_fin_reel;
 
 
  public $weight;
 
  public $weight_units; // scale -3, 0, 3, 6
  public $length;
  public $length_units; // scale -3, 0, 3, 6
  public $width;
  public $width_units;  // scale -3, 0, 3, 6
  public $height;
  public $height_units; // scale -3, 0, 3, 6
  public $surface;
  public $surface_units;  // scale -3, 0, 3, 6
  public $volume;
  public $volume_units; // scale -3, 0, 3, 6
  public $multilangs;
 
  public $product_type;
 
  public $fk_product;
 
  public $desc;
 
  public $description;
 
  public $product;
 
  public $product_ref;
 
  public $product_label;
 
  public $product_barcode;
 
  public $product_desc;
 
  public $product_custom_code;
 
  public $product_custom_country_code;
 
  public $product_custom_country_id;
 
  public $fk_product_type;
 
  public $qty;
  public $duree;
  public $remise_percent;
 
  public $info_bits;
 
  public $special_code;
 
  public $subprice;
 
  public $subprice_ttc;
 
  public $tva_tx;
 
  public $fk_multicurrency;
 
  public $multicurrency_code;
 
  public $multicurrency_subprice;
 
  public $multicurrency_subprice_ttc;
 
  public $multicurrency_total_ht;
 
  public $multicurrency_total_tva;
 
  public $multicurrency_total_localtax1;  // not in database
 
  public $multicurrency_total_localtax2;  // not in database
 
  public $multicurrency_total_ttc;
 
 
  public function __construct($db)
  {
    $this->db = $db;
  }
 
  public function getLabelOfUnit($type = 'long', $outputlangs = null, $noentities = 0)
  {
    global $langs;
 
    if (empty($this->fk_unit)) {
      return '';
    }
    if (empty($outputlangs)) {
      $outputlangs = $langs;
    }
 
    $outputlangs->load('products');
    $label = '';
 
    $sql = "SELECT code, label, short_label FROM ".$this->db->prefix()."c_units where rowid = ".((int) $this->fk_unit);
 
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->error = $this->db->error();
      dol_syslog(get_class($this)."::getLabelOfUnit Error ".$this->error, LOG_ERR);
      return -1;
    } elseif ($this->db->num_rows($resql) > 0 && $res = $this->db->fetch_array($resql)) {
      if ($type == 'short') {
        if ($noentities) {
          $label = $outputlangs->transnoentitiesnoconv($res['short_label']);
        } else {
          $label = $outputlangs->trans($res['short_label']);
        }
      } elseif ($type == 'code') {
        $label = $res['code'];
      } else {
        if ($outputlangs->trans('unit'.$res['code']) == 'unit'.$res['code']) {
          // No translation available
          $label = $res['label'];
        } else {
          // Return the translated value
          if ($noentities) {
            $label = $outputlangs->transnoentitiesnoconv('unit'.$res['code']);
          } else {
            $label = $outputlangs->trans('unit'.$res['code']);
          }
        }
      }
    }
    $this->db->free($resql);
 
    return $label;
  }
 
  public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
  {
    return -1;  // NOK because nothing done.
  }
 
  public function getNomUrl($withpicto = 0)
  {
    $parentattribute = $this->fk_parent_attribute;
 
    /*
    if ($parentattribute) {
      return 'Parent #'.$this->$parentattribute.' - Line #'.$this->id;
    } else {
      return 'Line #'.$this->id;
    }
    */
 
    $parent_element_properties = getElementProperties($this->parent_element);
    $parent_classname = $parent_element_properties['classname'];
    $parent_element = new $parent_classname($this->db);
    $parentattribute = $this->fk_parent_attribute;
    if ($parentattribute && method_exists($parent_element, 'fetch')) {
      $parent_element->fetch($this->$parentattribute); // @phan-suppress-current-line PhanPluginUnknownObjectMethodCall
    }
 
    return $parent_element->getNomUrl($withpicto).' - Line #'.$this->id; // @phan-suppress-current-line PhanPluginUnknownObjectMethodCall
  }
 
  public function wasEnteredIncludingTax()
  {
    return isset($this->subprice_ttc) && (float) $this->subprice_ttc != 0;
  }
 
  public function getPriceBaseType()
  {
    return $this->wasEnteredIncludingTax() ? 'TTC' : 'HT';
  }
}