modReception.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2018    Quentin Vial-Gouteyron    <quentin.vial-gouteyron@atm-consulting.fr>
 * Copyright (C) 2024-2026  Frédéric France     <frederic.france@free.fr>
 * 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/>.
 */
 
include_once DOL_DOCUMENT_ROOT.'/core/modules/DolibarrModules.class.php';
 
 
class modReception extends DolibarrModules
{
  public function __construct($db)
  {
    global $conf, $user;
 
    $this->db = $db;
    $this->numero = 94160;
 
    $this->family = "srm";
    $this->module_position = '40';
    // Module label (no space allowed), used if translation string 'ModuleXXXName' not found (where XXX is value of numeric property 'numero' of module)
    $this->name = preg_replace('/^mod/i', '', get_class($this));
    $this->description = "ReceptionDescription";
 
    // Possible values for version are: 'development', 'experimental', 'dolibarr' or version
    $this->version = 'dolibarr';
 
    $this->const_name = 'MAIN_MODULE_'.strtoupper($this->name);
    $this->picto = "dollyrevert";
 
    // Data directories to create when module is enabled
    $this->dirs = [
      "/reception/receipt",
      "/reception/receipt/temp",
      "/doctemplates/receptions"
    ];
 
    // Config pages
    $this->config_page_url = array("reception_setup.php");
 
    // Dependencies
    $this->depends = array("modFournisseur");
    $this->requiredby = array();
    $this->conflictwith = array();
    $this->langfiles = array('receptions');
    // Constants
    $this->const = [
      [
        "RECEPTION_ADDON_PDF",
        "chaine",
        "squille",
        'Nom du gestionnaire de generation des bons receptions en PDF',
        0,
      ],
      [
        "RECEPTION_ADDON_NUMBER",
        "chaine",
        "mod_reception_beryl",
        'Name for numbering manager for receptions',
        0,
      ],
      [
        "RECEPTION_ADDON_PDF_ODT_PATH",
        "chaine",
        "DOL_DATA_ROOT".($conf->entity > 1 ? '/'.$conf->entity : '')."/doctemplates/receptions",
        "",
        0,
      ],
      [
        "MAIN_SUBMODULE_RECEPTION",
        "chaine",
        "1",
        "Enable receptions",
        0,
      ],
    ];
 
    // Boxes
    $this->boxes = array();
 
    // Permissions
    $this->rights = array();
    $this->rights_class = 'reception';
    $r = 0;
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r;
    $this->rights[$r][1] = 'Read receptions';
    $this->rights[$r][2] = 'r';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'lire';
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r;
    $this->rights[$r][1] = 'Create receptions';
    $this->rights[$r][2] = 'w';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'creer';
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r;
    $this->rights[$r][1] = 'Validate receptions';
    $this->rights[$r][2] = 'd';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'reception_advance';
    $this->rights[$r][5] = 'validate';
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r; // Permission id (must not be already used)
    $this->rights[$r][1] = 'Send receptions to customers'; // Permission label
    $this->rights[$r][2] = 'd'; // Permission type (deprecated)
    $this->rights[$r][3] = 0; // Permission by default for new user (0/1)
    $this->rights[$r][4] = 'reception_advance';
    $this->rights[$r][5] = 'send';
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r;
    $this->rights[$r][1] = 'Export receptions';
    $this->rights[$r][2] = 'r';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'reception';
    $this->rights[$r][5] = 'export';
 
    $r++;
    $this->rights[$r][0] = $this->numero.$r;
    $this->rights[$r][1] = 'Delete receptions';
    $this->rights[$r][2] = 'd';
    $this->rights[$r][3] = 0;
    $this->rights[$r][4] = 'supprimer';
 
 
    // Menus
    //-------
    $this->menu = 1; // This module add menu entries. They are coded into menu manager.
 
 
    // Exports
    //--------
    $r = 0;
 
    include_once DOL_DOCUMENT_ROOT.'/fourn/class/fournisseur.commande.class.php';
    $shipment = new CommandeFournisseur($this->db);
    $contact_arrays = $shipment->liste_type_contact('external', '', 0, 0, '');
    if (is_array($contact_arrays) && count($contact_arrays) > 0) {
      $idcontacts = implode(',', array_keys($shipment->liste_type_contact('external', '', 0, 0, '')));
    } else {
      $idcontacts = 0;
    }
 
 
    $r++;
    $this->export_code[$r] = $this->rights_class.'_'.$r;
    $this->export_label[$r] = 'Receptions'; // Translation key (used only if key ExportDataset_xxx_z not found)
    $this->export_permission[$r] = array(array("reception", "reception", "export"));
    $this->export_fields_array[$r] = array(
      's.rowid' => "IdCompany", 's.nom' => 'ThirdParty', 's.address' => 'Address', 's.zip' => 'Zip', 's.town' => 'Town',
      'd.nom' => 'State', 'co.label' => 'Country', 'co.code' => 'CountryCode', 's.phone' => 'Phone', 's.siren' => 'ProfId1', 's.siret' => 'ProfId2', 's.ape' => 'ProfId3', 's.idprof4' => 'ProfId4', 's.idprof5' => 'ProfId5', 's.idprof6' => 'ProfId6',
      'c.rowid' => "Id", 'c.ref' => "Ref", 'c.ref_supplier' => "RefSupplier", 'c.fk_soc' => "IdCompany", 'c.date_creation' => "DateCreation", 'c.date_delivery' => "DateDeliveryPlanned", 'c.tracking_number' => "TrackingNumber", 'c.height' => "Height", 'c.width' => "Width", 'c.size' => "Depth", 'c.size_units' => 'SizeUnits', 'c.weight' => "Weight", 'c.weight_units' => "WeightUnits", 'c.fk_statut' => 'Status', 'c.note_public' => "NotePublic", 'ed.rowid' => 'LineId',
      'ed.comment' => 'Description', 'ed.qty' => "Qty",
      'p.rowid' => 'ProductId', 'p.ref' => 'ProductRef', 'p.label' => 'ProductLabel', 'p.weight' => 'ProductWeight', 'p.weight_units' => 'WeightUnits', 'p.volume' => 'ProductVolume', 'p.volume_units' => 'VolumeUnits'
    );
    if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
      $this->export_fields_array[$r] += array('sp.rowid' => 'IdContact', 'sp.lastname' => 'Lastname', 'sp.firstname' => 'Firstname', 'sp.note_public' => 'NotePublic');
    }
    //$this->export_TypeFields_array[$r]=array('s.rowid'=>"Numeric",'s.nom'=>'Text','s.address'=>'Text','s.zip'=>'Text','s.town'=>'Text','co.label'=>'List:c_country:label:label','co.code'=>'Text','s.phone'=>'Text','s.siren'=>'Text','s.siret'=>'Text','s.ape'=>'Text','s.idprof4'=>'Text','c.ref'=>"Text",'c.ref_client'=>"Text",'c.date_creation'=>"Date",'c.date_commande'=>"Date",'c.amount_ht'=>"Numeric",'c.remise_percent'=>"Numeric",'c.total_ht'=>"Numeric",'c.total_ttc'=>"Numeric",'c.facture'=>"Boolean",'c.fk_statut'=>'Status','c.note_public'=>"Text",'c.date_livraison'=>'Date','ed.qty'=>"Text");
    $this->export_TypeFields_array[$r] = array(
      's.nom' => 'Text', 's.address' => 'Text', 's.zip' => 'Text', 's.town' => 'Text',
      'co.label' => 'List:c_country:label:label', 'co.code' => 'Text', 's.phone' => 'Text', 's.siren' => 'Text', 's.siret' => 'Text', 's.ape' => 'Text', 's.idprof4' => 'Text',
      'c.ref' => "Text", 'c.ref_supplier' => "Text", 'c.date_creation' => "Date", 'c.date_delivery' => "Date", 'c.tracking_number' => "Numeric", 'c.height' => "Numeric", 'c.width' => "Numeric", 'c.weight' => "Numeric", 'c.fk_statut' => 'Status', 'c.note_public' => "Text",
      'ed.qty' => "Numeric", 'd.nom' => 'Text'
    );
    $this->export_entities_array[$r] = array(
      's.rowid' => "company", 's.nom' => 'company', 's.address' => 'company', 's.zip' => 'company', 's.town' => 'company',
      'd.nom' => 'company', 'co.label' => 'company', 'co.code' => 'company', 's.fk_pays' => 'company', 's.phone' => 'company', 's.siren' => 'company', 's.ape' => 'company', 's.siret' => 'company', 's.idprof4' => 'company', 's.idprof5' => 'company', 's.idprof6' => 'company',
      'c.rowid' => "reception", 'c.ref' => "reception", 'c.ref_supplier' => "reception", 'c.fk_soc' => "reception", 'c.date_creation' => "reception", 'c.date_delivery' => "reception", 'c.tracking_number' => 'reception', 'c.height' => "reception", 'c.width' => "reception", 'c.size' => 'reception', 'c.size_units' => 'reception', 'c.weight' => "reception", 'c.weight_units' => 'reception', 'c.fk_statut' => "reception", 'c.note_public' => "reception",
      'ed.rowid' => 'reception_line', 'ed.comment' => 'reception_line', 'ed.qty' => "reception_line",
      'p.rowid' => 'product', 'p.ref' => 'product', 'p.label' => 'product', 'p.weight' => 'product', 'p.weight_units' => 'product', 'p.volume' => 'product', 'p.volume_units' => 'product'
    );
    if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
      $this->export_entities_array[$r] += array('sp.rowid' => 'contact', 'sp.lastname' => 'contact', 'sp.firstname' => 'contact', 'sp.note_public' => 'contact');
    }
    $this->export_dependencies_array[$r] = array('reception_line' => 'ed.rowid', 'product' => 'ed.rowid'); // To add unique key if we ask a field of a child to avoid the DISTINCT to discard them
    if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
      $keyforselect = 'socpeople';
      $keyforelement = 'contact';
      $keyforaliasextra = 'extra3';
      include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
    }
    $keyforselect = 'reception';
    $keyforelement = 'reception';
    $keyforaliasextra = 'extra';
    include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
    $keyforselect = 'receptiondet_batch';
    $keyforelement = 'reception_line';
    $keyforaliasextra = 'extra2';
    include DOL_DOCUMENT_ROOT.'/core/extrafieldsinexport.inc.php';
 
    $this->export_sql_start[$r] = 'SELECT DISTINCT ';
    $this->export_sql_end[$r]  = ' FROM '.MAIN_DB_PREFIX.'reception as c';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'reception_extrafields as extra ON c.rowid = extra.fk_object,';
    $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'societe as s';
    if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
      $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'societe_commerciaux as sc ON sc.fk_soc = s.rowid';
    }
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_departements as d ON s.fk_departement = d.rowid';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'c_country as co ON s.fk_pays = co.rowid,';
    $this->export_sql_end[$r] .= ' '.MAIN_DB_PREFIX.'receptiondet_batch as ed';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'receptiondet_batch_extrafields as extra2 ON ed.rowid = extra2.fk_object';
    $this->export_sql_end[$r] .= ' , '.MAIN_DB_PREFIX.'commande_fournisseurdet as cd';
    $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'product as p on cd.fk_product = p.rowid';
    if ($idcontacts && getDolGlobalString('RECEPTION_ADD_CONTACTS_IN_EXPORT')) {
      $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'element_contact as ee ON ee.element_id = cd.fk_commande AND ee.fk_c_type_contact IN ('.$this->db->sanitize($idcontacts).')';
      $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople as sp ON sp.rowid = ee.fk_socpeople';
      $this->export_sql_end[$r] .= ' LEFT JOIN '.MAIN_DB_PREFIX.'socpeople_extrafields as extra3 ON sp.rowid = extra3.fk_object';
    }
    $this->export_sql_end[$r] .= ' WHERE c.fk_soc = s.rowid AND c.rowid = ed.fk_reception AND ed.fk_elementdet = cd.rowid';
    $this->export_sql_end[$r] .= ' AND c.entity IN ('.getEntity('reception').')';
    if (!empty($user) && !$user->hasRight('societe', 'client', 'voir')) {
      $this->export_sql_end[$r] .= ' AND sc.fk_user = '.(empty($user) ? 0 : ((int) $user->id));
    }
  }
 
 
  public function init($options = '')
  {
    global $conf, $langs;
 
    // Permissions
    $this->remove($options);
 
    //ODT template
    $src = DOL_DOCUMENT_ROOT.'/install/doctemplates/reception/template_reception.odt';
    $dirodt = DOL_DATA_ROOT.($conf->entity > 1 ? '/'.$conf->entity : '').'/doctemplates/reception';
    $dest = $dirodt.'/template_reception.odt';
 
    if (file_exists($src) && !file_exists($dest)) {
      require_once DOL_DOCUMENT_ROOT.'/core/lib/files.lib.php';
      dol_mkdir($dirodt);
      $result = dol_copy($src, $dest, '0', 0);
      if ($result < 0) {
        $langs->load("errors");
        $this->error = $langs->trans('ErrorFailToCopyFile', $src, $dest);
        return 0;
      }
    }
 
    $sql = array();
 
    $sql = array(
      "DELETE FROM ".MAIN_DB_PREFIX."document_model WHERE nom = '".$this->db->escape($this->const[0][2])."' AND type = 'reception' AND entity = ".((int) $conf->entity),
      "INSERT INTO ".MAIN_DB_PREFIX."document_model (nom, type, entity) VALUES('".$this->db->escape($this->const[0][2])."','reception',".((int) $conf->entity).")",
      //"DELETE FROM ".MAIN_DB_PREFIX."const WHERE name IN ('STOCK_CALCULATE_ON_SUPPLIER_BILL', 'STOCK_CALCULATE_ON_SUPPLIER_VALIDATE_ORDER', 'STOCK_CALCULATE_ON_SUPPLIER_DISPATCH_ORDER', 'STOCK_CALCULATE_ON_RECEPTION', 'STOCK_CALCULATE_ON_RECEPTION_CLOSE') AND entity = ".((int) $conf->entity),
      //"INSERT INTO ".MAIN_DB_PREFIX."const (name, value, entity) VALUES ('STOCK_CALCULATE_ON_RECEPTION_CLOSE', 1, ".((int) $conf->entity).")"
    );
 
    return $this->_init($sql, $options);
  }
}