entrepot.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2003-2006  Rodolphe Quiedeville    <rodolphe@quiedeville.org>
 * Copyright (C) 2004-2010  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2005-2008  Regis Houssin           <regis.houssin@inodbox.com>
 * Copyright (C) 2011     Juanjo Menent           <jmenent@2byte.es>
 * Copyright (C) 2016     Francis Appels          <francis.appels@yahoo.com>
 * Copyright (C) 2019-2025  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024-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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
 
class Entrepot extends CommonObject
{
  public $element = 'stock';
 
  public $table_element = 'entrepot';
 
  public $picto = 'stock';
 
  public $libelle;
 
  public $label;
 
  public $barcode;
 
  public $description;
 
  public $fk_departement;
 
  public $statut;
 
  public $lieu;
 
  public $address;
 
  public $zip;
 
  public $town;
 
  public $phone;
 
  public $fax;
 
  public $fk_parent;
 
  public $fk_project;
 
  public $warehouse_usage;
 
  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'ID', 'enabled' => 1, 'visible' => 0, 'notnull' => 1, 'position' => 10),
    'entity' => array('type' => 'integer', 'label' => 'Entity', 'enabled' => 1, 'visible' => 0, 'default' => '1', 'notnull' => 1, 'index' => 1, 'position' => 15),
    'ref' => array('type' => 'varchar(255)', 'label' => 'Ref', 'enabled' => 1, 'visible' => 1, 'showoncombobox' => 1, 'position' => 25, 'searchall' => 1),
    'description' => array('type' => 'text', 'label' => 'Description', 'enabled' => 1, 'visible' => -2, 'position' => 35, 'searchall' => 1),
    'lieu' => array('type' => 'varchar(64)', 'label' => 'LocationSummary', 'enabled' => 1, 'visible' => 1, 'position' => 40, 'showoncombobox' => 2, 'searchall' => 1),
    'fk_parent' => array('type' => 'integer:Entrepot:product/stock/class/entrepot.class.php:1:((statut:=:1) AND (entity:IN:__SHARED_ENTITIES__))', 'label' => 'ParentWarehouse', 'enabled' => 1, 'visible' => -2, 'position' => 41),
    'fk_project' => array('type' => 'integer:Project:projet/class/project.class.php:1:(fk_statut:=:1)', 'label' => 'Project', 'enabled' => 'isModEnabled("project")', 'visible' => -1, 'position' => 42),
    'address' => array('type' => 'varchar(255)', 'label' => 'Address', 'enabled' => 1, 'visible' => -2, 'position' => 45, 'searchall' => 1),
    'zip' => array('type' => 'varchar(10)', 'label' => 'Zip', 'enabled' => 1, 'visible' => -2, 'position' => 50, 'searchall' => 1),
    'town' => array('type' => 'varchar(50)', 'label' => 'Town', 'enabled' => 1, 'visible' => -2, 'position' => 55, 'searchall' => 1),
    'fk_departement' => array('type' => 'integer', 'label' => 'State', 'enabled' => 1, 'visible' => 0, 'position' => 60),
    'fk_pays' => array('type' => 'integer:Ccountry:core/class/ccountry.class.php', 'label' => 'Country', 'enabled' => 1, 'visible' => -1, 'position' => 65),
    'phone' => array('type' => 'varchar(20)', 'label' => 'Phone', 'enabled' => 1, 'visible' => -2, 'position' => 70, 'searchall' => 1),
    'fax' => array('type' => 'varchar(20)', 'label' => 'Fax', 'enabled' => 1, 'visible' => -2, 'position' => 75, 'searchall' => 1),
    //'fk_user_author' =>array('type'=>'integer', 'label'=>'UserAuthor', 'enabled'=>1, 'visible'=>-2, 'position'=>82),
    'datec' => array('type' => 'datetime', 'label' => 'DateCreation', 'enabled' => 1, 'visible' => -2, 'position' => 300),
    'tms' => array('type' => 'timestamp', 'label' => 'DateModification', 'enabled' => 1, 'visible' => -2, 'notnull' => 1, 'position' => 301),
    'warehouse_usage' => array('type' => 'integer', 'label' => 'WarehouseUsage', 'enabled' => 'getDolGlobalInt("STOCK_USE_WAREHOUSE_USAGE")', 'visible' => 1, 'position' => 400, 'default' => '1', 'arrayofkeyval' => array(1 => 'InternalWarehouse', 2 => 'ExternalWarehouse')),
    //'import_key' =>array('type'=>'varchar(14)', 'label'=>'ImportId', 'enabled'=>1, 'visible'=>-2, 'position'=>1000),
    //'model_pdf' =>array('type'=>'varchar(255)', 'label'=>'ModelPDF', 'enabled'=>1, 'visible'=>0, 'position'=>1010),
    'statut' => array('type' => 'tinyint(4)', 'label' => 'Status', 'enabled' => 1, 'visible' => 1, 'position' => 500, 'css' => 'minwidth50'),
  );
  // END MODULEBUILDER PROPERTIES
 
 
  const STATUS_CLOSED = 0;
 
  const STATUS_OPEN_ALL = 1;
 
  const STATUS_OPEN_INTERNAL = 2;
 
 
  const USAGE_INTERNAL = 1;
 
  const USAGE_EXTERNAL = 2;
 
 
 
  public function __construct($db)
  {
    $this->db = $db;
 
    $this->ismultientitymanaged = 1;
 
    $this->labelStatus[self::STATUS_CLOSED] = 'Closed2';
    if (getDolGlobalString('ENTREPOT_EXTRA_STATUS')) {
      $this->labelStatus[self::STATUS_OPEN_ALL] = 'OpenAnyMovement';
      $this->labelStatus[self::STATUS_OPEN_INTERNAL] = 'OpenInternal';
    } else {
      $this->labelStatus[self::STATUS_OPEN_ALL] = 'Opened';
    }
  }
 
  public function create($user, $notrigger = 0)
  {
    global $conf;
 
    $error = 0;
 
    $this->label = trim($this->label);
 
    // Error if label not defined
    if ($this->label == '') {
      $this->error = "ErrorFieldRequired";
      return 0;
    }
    if (empty($this->country_id) && !empty($this->country_code)) {
      $country_id = getCountry($this->country_code, '3');
      $this->country_id = is_int($country_id) ? $country_id : 0;
    }
 
    $now = dol_now();
 
    $this->db->begin();
 
    $sql = "INSERT INTO ".$this->db->prefix()."entrepot (ref, entity, datec, fk_user_author, fk_parent, fk_project)";
    $sql .= " VALUES ('".$this->db->escape($this->label)."', ".((int) $conf->entity).", '".$this->db->idate($now)."', ".((int) $user->id).", ".($this->fk_parent > 0 ? ((int) $this->fk_parent) : "NULL").", ".($this->fk_project > 0 ? ((int) $this->fk_project) : "NULL").")";
 
    dol_syslog(get_class($this)."::create", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      $id = $this->db->last_insert_id($this->db->prefix()."entrepot");
      if ($id > 0) {
        $this->id = $id;
        $result = $this->update($id, $user);
        if ($result <= 0) {
          $error++;
        }
 
        // Actions on extra fields
        if (!$error) {
          $result = $this->insertExtraFields();
          if ($result < 0) {
            $error++;
          }
        }
 
        if (!$error && !$notrigger) {
          // Call triggers
          $result = $this->call_trigger('WAREHOUSE_CREATE', $user);
          if ($result < 0) {
            $error++;
          }
          // End call triggers
        }
 
        if (!$error) {
          $this->db->commit();
          return $id;
        } else {
          dol_syslog(get_class($this)."::create return -3");
          $this->db->rollback();
          return -3;
        }
      } else {
        $this->error = "Failed to get insert id";
        dol_syslog(get_class($this)."::create return -2");
        return -2;
      }
    } else {
      $this->error = $this->db->error();
      dol_syslog(get_class($this)."::create Error ".$this->db->error());
      $this->db->rollback();
      return -1;
    }
  }
 
  public function update($id, $user, $notrigger = 0)
  {
    if (empty($this->country_id) && !empty($this->country_code)) {
      $country_id = getCountry($this->country_code, '3');
      $this->country_id = is_int($country_id) ? $country_id : 0;
    }
 
    $error = 0;
 
    if (empty($id)) {
      $id = $this->id;
    }
 
    // Check if new parent is already a child of current warehouse
    if (!empty($this->fk_parent)) {
      $TChildWarehouses = array($id);
      $TChildWarehouses = $this->get_children_warehouses($this->id, $TChildWarehouses);
      if (in_array($this->fk_parent, $TChildWarehouses)) {
        $this->error = 'ErrorCannotAddThisParentWarehouse';
        return -2;
      }
    }
 
    $this->label = trim($this->label);
    $this->barcode = trim($this->barcode);
    $this->model_pdf = trim($this->model_pdf);
 
    $this->description = trim($this->description);
 
    $this->lieu = trim($this->lieu);
 
    $this->address = trim($this->address);
    $this->zip = trim($this->zip);
    $this->town = trim($this->town);
    $this->country_id = ($this->country_id > 0 ? $this->country_id : 0);
 
    $sql = "UPDATE ".$this->db->prefix()."entrepot";
    $sql .= " SET ref = '".$this->db->escape($this->label)."'";
    $sql .= ", fk_parent = ".(($this->fk_parent > 0) ? $this->fk_parent : "NULL");
    $sql .= ", fk_project = ".(($this->fk_project > 0) ? $this->fk_project : "NULL");
    $sql .= ", description = '".$this->db->escape($this->description)."'";
    $sql .= ", statut = ".((int) $this->statut);
    $sql .= ", lieu = '".$this->db->escape($this->lieu)."'";
    $sql .= ", address = '".$this->db->escape($this->address)."'";
    $sql .= ", zip = '".$this->db->escape($this->zip)."'";
    $sql .= ", town = '".$this->db->escape($this->town)."'";
    $sql .= ", fk_pays = ".((int) $this->country_id);
    $sql .= ", phone = '".$this->db->escape($this->phone)."'";
    $sql .= ", fax = '".$this->db->escape($this->fax)."'";
    $sql .= ", barcode = '".$this->db->escape($this->barcode)."'";
    $sql .= ", fk_departement = ".((int) $this->fk_departement);
    $sql .= ", fk_barcode_type = ".((int) $this->barcode_type);
    $sql .= ", warehouse_usage = ".((int) $this->warehouse_usage);
    $sql .= ", fk_user_author = ".((int) $this->user_creation_id);
    $sql .= ", model_pdf = '".$this->db->escape($this->model_pdf)."'";
    $sql .= ", import_key = ".(isset($this->import_key) ? "'".$this->db->escape($this->import_key)."'" : "null");
    $sql .= " WHERE rowid = ".((int) $id);
 
    $this->db->begin();
 
    dol_syslog(get_class($this)."::update", LOG_DEBUG);
    $resql = $this->db->query($sql);
 
    if (!$resql) {
      $error++;
      $this->errors[] = "Error ".$this->db->lasterror();
    }
 
    if (!$error) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
 
    if (!$error && !$notrigger) {
      // Call triggers
      $result = $this->call_trigger('WAREHOUSE_MODIFY', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      $this->error = $this->db->lasterror();
      return -1;
    }
  }
 
 
  public function delete($user, $notrigger = 0)
  {
    global $conf;
 
    $error = 0;
 
    dol_syslog(get_class($this)."::delete id=".$this->id, LOG_DEBUG);
 
    $this->db->begin();
 
    if (empty($notrigger)) {
      // Call trigger
      $result = $this->call_trigger('WAREHOUSE_DELETE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $sql = "DELETE FROM ".$this->db->prefix()."product_batch";
      $sql .= " WHERE fk_product_stock IN (SELECT rowid FROM ".$this->db->prefix()."product_stock as ps WHERE ps.fk_entrepot = ".((int) $this->id).")";
      $result = $this->db->query($sql);
      if (!$result) {
        $error++;
        $this->errors[] = $this->db->lasterror();
      }
    }
 
    if (!$error) {
      $elements = array('stock_mouvement', 'product_stock');
      foreach ($elements as $table) {
        if (!$error) {
          $sql = "DELETE FROM ".$this->db->prefix().$table;
          $sql .= " WHERE fk_entrepot = ".((int) $this->id);
 
          $result = $this->db->query($sql);
          if (!$result) {
            $error++;
            $this->errors[] = $this->db->lasterror();
          }
        }
      }
    }
 
    // Remove extrafields
    if (!$error) {
      $result = $this->deleteExtraFields();
      if ($result < 0) {
        $error++;
        dol_syslog(get_class($this)."::delete Error ".$this->error, LOG_ERR);
      }
    }
 
    if (!$error) {
      $sql = "DELETE FROM ".$this->db->prefix()."entrepot";
      $sql .= " WHERE rowid = ".((int) $this->id);
      $resql1 = $this->db->query($sql);
      if (!$resql1) {
        $error++;
        $this->errors[] = $this->db->lasterror();
        dol_syslog(get_class($this)."::delete Error ".$this->db->lasterror(), LOG_ERR);
      }
    }
 
    if (!$error) {
      // Update denormalized fields because we change content of produt_stock. Warning: Do not use "SET p.stock", does not works with pgsql
      $sql = "UPDATE ".$this->db->prefix()."product as p SET stock = (SELECT SUM(ps.reel) FROM ".$this->db->prefix()."product_stock as ps WHERE ps.fk_product = p.rowid)";
      $resql2 = $this->db->query($sql);
      if (!$resql2) {
        $error++;
        $this->errors[] = $this->db->lasterror();
        dol_syslog(get_class($this)."::delete Error ".$this->db->lasterror(), LOG_ERR);
      }
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1;
    }
  }
 
 
  public function fetch($id, $ref = '')
  {
    global $conf;
 
    dol_syslog(get_class($this)."::fetch id=".$id." ref=".$ref);
 
    // Check parameters
    if (!$id && !$ref) {
      $this->error = 'ErrorWrongParameters';
      dol_syslog(get_class($this)."::fetch ".$this->error);
      return -1;
    }
 
    $sql  = "SELECT rowid, entity, fk_parent, fk_project, ref as label, description, statut, lieu, address, zip, town, fk_pays as country_id, phone, fax,";
    $sql .= " model_pdf, import_key, datec as date_creation, tms as date_modification, fk_departement, barcode, fk_barcode_type, warehouse_usage, fk_user_author as user_creation_id";
    $sql .= " FROM ".$this->db->prefix()."entrepot";
    if ($id) {
      $sql .= " WHERE rowid = ".((int) $id);
    } else {
      $sql .= " WHERE entity IN (".getEntity('stock').")";
      if ($ref) {
        $sql .= " AND ref = '".$this->db->escape($ref)."'";
      }
    }
 
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result) > 0) {
        $obj = $this->db->fetch_object($result);
 
        $this->id             = $obj->rowid;
        $this->entity         = $obj->entity;
        $this->fk_parent      = $obj->fk_parent;
        $this->fk_project     = $obj->fk_project;
        $this->ref            = $obj->label;
        $this->label          = $obj->label;
        $this->description    = $obj->description;
        $this->statut         = $obj->statut;
        $this->status         = $obj->statut;
        $this->lieu           = $obj->lieu;
        $this->address        = $obj->address;
        $this->zip            = $obj->zip;
        $this->town           = $obj->town;
        $this->country_id     = $obj->country_id;
        $this->phone          = $obj->phone;
        $this->fax            = $obj->fax;
 
        $this->date_creation  = $obj->date_creation;
        $this->barcode      = $obj->barcode;
        $this->fk_departement = $obj->fk_departement;
        $this->barcode_type   = $obj->fk_barcode_type;
        $this->warehouse_id   = $obj->rowid;
 
        $this->warehouse_usage = $obj->warehouse_usage;
        $this->user_creation_id = $obj->user_creation_id;
        $this->date_modification = $obj->date_modification;
 
        $this->model_pdf      = $obj->model_pdf;
        $this->import_key     = $obj->import_key;
 
        // Retrieve all extrafield
        // fetch optionals attributes and labels
        $this->fetch_optionals();
 
        include_once DOL_DOCUMENT_ROOT.'/core/lib/company.lib.php';
        $tmp = getCountry($this->country_id, 'all');
        $this->country = $tmp['label'];
        $this->country_code = $tmp['code'];
 
        return 1;
      } else {
        $this->error = "Record Not Found";
        return 0;
      }
    } else {
      $this->error = $this->db->error();
      return -1;
    }
  }
 
 
  public function info($id)
  {
    $sql = "SELECT e.rowid, e.datec, e.tms as datem, e.fk_user_author";
    $sql .= " FROM ".$this->db->prefix()."entrepot as e";
    $sql .= " WHERE e.rowid = ".((int) $id);
 
    dol_syslog(get_class($this)."::info", LOG_DEBUG);
    $result = $this->db->query($sql);
    if ($result) {
      if ($this->db->num_rows($result)) {
        $obj = $this->db->fetch_object($result);
 
        $this->id = $obj->rowid;
 
        $this->user_creation_id = $obj->fk_user_author;
        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = empty($obj->datem) ? '' : $this->db->jdate($obj->datem);
      }
 
      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }
 
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function list_array($status = 1)
  {
    // phpcs:enable
    $liste = array();
 
    $sql = "SELECT rowid, ref as label";
    $sql .= " FROM ".$this->db->prefix()."entrepot";
    $sql .= " WHERE entity IN (".getEntity('stock').")";
    $sql .= " AND statut = ".((int) $status);
 
    $result = $this->db->query($sql);
    $i = 0;
    $num = $this->db->num_rows($result);
    if ($result) {
      while ($i < $num) {
        $row = $this->db->fetch_row($result);
        $liste[$row[0]] = $row[1];
        $i++;
      }
      $this->db->free($result);
    }
    return $liste;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function nb_different_products()
  {
    // phpcs:enable
    $ret = array();
 
    $sql = "SELECT count(distinct p.rowid) as nb";
    $sql .= " FROM ".$this->db->prefix()."product_stock as ps";
    $sql .= ", ".$this->db->prefix()."product as p";
    $sql .= " WHERE ps.fk_entrepot = ".((int) $this->id);
    $sql .= " AND ps.fk_product = p.rowid";
 
    //print $sql;
    $result = $this->db->query($sql);
    if ($result) {
      $obj = $this->db->fetch_object($result);
      $ret['nb'] = $obj->nb;
      $this->db->free($result);
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
 
    return $ret;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function nb_products()
  {
    global $conf;
    // phpcs:enable
    $ret = array();
 
    //For MultiCompany PMP per entity
    $separatedPMP = false;
    if (getDolGlobalString('MULTICOMPANY_PRODUCT_SHARING_ENABLED') && getDolGlobalString('MULTICOMPANY_PMP_PER_ENTITY_ENABLED')) {
      $separatedPMP = true;
    }
 
    if ($separatedPMP) {
      $sql = "SELECT sum(ps.reel) as nb, sum(ps.reel * pa.pmp) as value";
    } else {
      $sql = "SELECT sum(ps.reel) as nb, sum(ps.reel * p.pmp) as value";
    }
    $sql .= " FROM ".$this->db->prefix()."product_stock as ps";
    $sql .= ", ".$this->db->prefix()."product as p";
    if ($separatedPMP) {
      $sql .= ", ".$this->db->prefix()."product_perentity as pa";
    }
    $sql .= " WHERE ps.fk_entrepot = ".((int) $this->id);
    if ($separatedPMP) {
      $sql .= " AND pa.fk_product = p.rowid AND pa.entity = ". (int) $conf->entity;
    }
    $sql .= " AND ps.fk_product = p.rowid";
    //print $sql;
    $result = $this->db->query($sql);
    if ($result) {
      $obj = $this->db->fetch_object($result);
      $ret['nb'] = $obj->nb;
      $ret['value'] = $obj->value;
      $this->db->free($result);
    } else {
      $this->error = $this->db->lasterror();
      return -1;
    }
 
    return $ret;
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->statut, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;
 
    $statusType = 'status5';
    if ($status > 0) {
      $statusType = 'status4';
    }
 
    $langs->load('stocks');
    $label = $langs->transnoentitiesnoconv($this->labelStatus[$status]);
    $labelshort = $langs->transnoentitiesnoconv($this->labelStatus[$status]);
 
    return dolGetStatus($label, $labelshort, '', $statusType, $mode);
  }
 
  public function getTooltipContentArray($params)
  {
    global $conf, $langs, $user;
 
    $langs->load('stocks');
 
    $datas = [];
 
    $option = $params['option'] ?? '';
    $nofetch = !empty($params['nofetch']);
 
    if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
      return ['optimize' => $langs->trans("Warehouse")];
    }
    $datas['picto'] = img_picto('', $this->picto).' <u class="paddingrightonly">'.$langs->trans("Warehouse").'</u>';
    if (!empty($this->statut)) {
      $datas['picto'] .= ' '.$this->getLibStatut(5);
    }
    $datas['ref'] = '<br><b>'.$langs->trans('Ref').':</b> '.(empty($this->ref) ? $this->label : $this->ref);
    if (!empty($this->lieu)) {
      $datas['locationsummary'] = '<br><b>'.$langs->trans('LocationSummary').':</b> '.$this->lieu;
    }
    // show categories for this record only in ajax to not overload lists
    if (!$nofetch && isModEnabled('category')) {
      require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
      $form = new Form($this->db);
      $datas['categories_warehouse'] = '<br>' . $form->showCategories($this->id, Categorie::TYPE_WAREHOUSE, 1, 1);
    }
 
    return $datas;
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $showfullpath = 0, $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
    $langs->load("stocks");
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER') && $withpicto) {
      $withpicto = 0;
    }
 
    $result = '';
    $params = [
      'id' => $this->id,
      'objecttype' => $this->element,
      'option' => $option,
      'nofetch' => 1,
    ];
    $classfortooltip = 'classfortooltip';
    $dataparams = '';
    if (getDolGlobalInt('MAIN_ENABLE_AJAX_TOOLTIP')) {
      $classfortooltip = 'classforajaxtooltip';
      $dataparams = ' data-params="'.dol_escape_htmltag(json_encode($params)).'"';
      $label = 'ToComplete';
    } else {
      $label = implode($this->getTooltipContentArray($params));
    }
 
    $url = DOL_URL_ROOT.'/product/stock/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 (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("Warehouse");
        $linkclose .= ' alt="'.dolPrintHTMLForAttribute($label).'"';
      }
      $linkclose .= ($label ? ' title="'.dolPrintHTMLForAttribute($label).'"' : ' title="tocomplete"');
      $linkclose .= $dataparams.' class="'.$classfortooltip.'"';
    }
 
    $linkstart = '<a href="'.$url.'"';
    $linkstart .= $linkclose.'>';
    $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 ' : '').'"'), 0, 0, $notooltip ? 0 : 1);
    }
    if ($withpicto != 2) {
      $result .= (($showfullpath || getDolGlobalString('STOCK_ALWAYS_SHOW_FULL_ARBO')) ? $this->get_full_arbo() : $this->label);
    }
    $result .= $linkend;
 
    global $action;
    $hookmanager->initHooks(array('warehousedao'));
    $parameters = array('id' => $this->id, 'getnomurl' => &$result, 'withpicto' => $withpicto, 'option' => $option, 'showfullpath' => $showfullpath, 'notooltip' => $notooltip);
    $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 initAsSpecimen()
  {
    global $user, $langs, $conf, $mysoc;
 
    $now = dol_now();
 
    // Initialize parameters
    $this->id = 0;
    $this->label = 'WAREHOUSE SPECIMEN';
    $this->description = 'WAREHOUSE SPECIMEN '.dol_print_date($now, 'dayhourlog');
    $this->statut = 1;
    $this->specimen = 1;
 
    $this->lieu = 'Location test';
    $this->address = '21 jump street';
    $this->zip = '99999';
    $this->town = 'MyTown';
    $this->country_id = 1;
    $this->country_code = 'FR';
 
    return 1;
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function get_full_arbo()
  {
    // phpcs:enable
    $TArbo = array($this->label);
 
    $protection = 100; // We limit depth of warehouses to 100
 
    $warehousetmp = new Entrepot($this->db);
 
    $parentid = $this->fk_parent; // If parent_id not defined on current object, we do not start consecutive searches of parents
    $i = 0;
    while ($parentid > 0 && $i < $protection) {
      $sql = "SELECT fk_parent FROM ".$this->db->prefix()."entrepot";
      $sql .= " WHERE rowid = ".((int) $parentid);
 
      $resql = $this->db->query($sql);
      if ($resql) {
        $objarbo = $this->db->fetch_object($resql);
        if ($objarbo) {
          $warehousetmp->fetch($parentid);
          $TArbo[] = $warehousetmp->label;
          $parentid = $objarbo->fk_parent;
        } else {
          break;
        }
      } else {
        dol_print_error($this->db);
      }
 
      $i++;
    }
 
    return implode(' >> ', array_reverse($TArbo));
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function get_children_warehouses($id, &$TChildWarehouses)
  {
    // phpcs:enable
 
    $sql = "SELECT rowid FROM ".$this->db->prefix()."entrepot WHERE fk_parent = ".((int) $id);
 
    $resql = $this->db->query($sql);
    if ($resql) {
      while ($res = $this->db->fetch_object($resql)) {
        $TChildWarehouses[] = $res->rowid;
        $this->get_children_warehouses($res->rowid, $TChildWarehouses);
      }
    }
 
    return $TChildWarehouses;
  }
 
  public function generateDocument($modele, $outputlangs, $hidedetails = 0, $hidedesc = 0, $hideref = 0)
  {
    global $conf, $user, $langs;
 
    $langs->load("stocks");
    $outputlangs->load("products");
 
    if (!dol_strlen($modele)) {
      $modele = 'standard';
 
      if ($this->model_pdf) {
        $modele = $this->model_pdf;
      } elseif (getDolGlobalString('STOCK_ADDON_PDF')) {
        $modele = getDolGlobalString('STOCK_ADDON_PDF');
      }
    }
 
    $modelpath = "core/modules/stock/doc/";
 
    return $this->commonGenerateDocument($modelpath, $modele, $outputlangs, $hidedetails, $hidedesc, $hideref);
  }
 
  public function setCategories($categories)
  {
    require_once DOL_DOCUMENT_ROOT.'/categories/class/categorie.class.php';
    return parent::setCategoriesCommon($categories, Categorie::TYPE_WAREHOUSE);
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    global $langs;
 
    $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 .= '<div class="info-box-icon bg-infobox-action" >';
    $return .= img_picto('', $this->picto);
    $return .= '</div>';
    $return .= '<div class="info-box-content" >';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">' . $this->getNomUrl() . '</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (!empty($this->lieu)) {
      $return .= '<br><span class="info-box-label opacitymedium">'.$this->lieu.'</span>';
    }
    if ($arraydata['sellvalue'] != 0) {
      if ($arraydata['isMultiPrices']) {
        $return .= '<br><span class="info-box-label opacitymedium">'.$langs->trans("Variable").' '.$langs->trans('EstimatedStockValueSell').'</span>';
      } else {
        $return .= '<br><span class="info-box-label amount">'.price($arraydata['sellvalue']).'</span>';
      }
    }
    $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3).'</div>';
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
    return $return;
  }
}