bom_net_needs.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2017-2020  Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2019-2026  Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2025   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/>.
 */
 
// Load Dolibarr environment
require '../main.inc.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/html.formcompany.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/html.formfile.class.php';
require_once DOL_DOCUMENT_ROOT.'/bom/class/bom.class.php';
require_once DOL_DOCUMENT_ROOT.'/bom/lib/bom.lib.php';
 
// Load translation files required by the page
$langs->loadLangs(array("mrp", "other", "stocks"));
 
// Get parameters
$id = GETPOSTINT('id');
$lineid = GETPOSTINT('lineid');
$ref = GETPOST('ref', 'alpha');
$action = GETPOST('action', 'aZ09');
$confirm = GETPOST('confirm', 'alpha');
$cancel = GETPOST('cancel', 'alpha');
$contextpage = GETPOST('contextpage', 'aZ') ? GETPOST('contextpage', 'aZ') : 'bomnet_needs'; // To manage different context of search
$backtopage = GETPOST('backtopage', 'alpha');
 
 
// Initialize a technical objects
$object = new BOM($db);
 
// Initialize a technical objects for hooks
$hookmanager->initHooks(array('bomnetneeds')); // Note that conf->hooks_modules contains array
 
// Massaction
$diroutputmassaction = getMultidirOutput($object) . '/temp/massgeneration/'.$user->id;
 
// Fetch optionals attributes and labels
$extrafields->fetch_name_optionals_label($object->table_element);
$search_array_options = $extrafields->getOptionalsFromPost($object->table_element, '', 'search_');
 
// Initialize array of search criteria
$search_all = GETPOST("search_all", 'alpha');
$search = array();
foreach ($object->fields as $key => $val) {
  if (GETPOST('search_'.$key, 'alpha')) {
    $search[$key] = GETPOST('search_'.$key, 'alpha');
  }
}
 
if (empty($action) && empty($id) && empty($ref)) {
  $action = 'view';
}
 
// Load object
include DOL_DOCUMENT_ROOT.'/core/actions_fetchobject.inc.php'; // Must be 'include', not 'include_once'.
if ($object->id > 0) {
  $object->calculateCosts();
}
 
 
// Security check - Protection if external user
//if ($user->socid > 0) accessforbidden();
//if ($user->socid > 0) $socid = $user->socid;
$isdraft = (($object->status == $object::STATUS_DRAFT) ? 1 : 0);
restrictedArea($user, 'bom', $object->id, $object->table_element, '', '', 'rowid', $isdraft);
 
// Permissions
$permissionnote = $user->hasRight('bom', 'write'); // Used by the include of actions_setnotes.inc.php
$permissiondellink = $user->hasRight('bom', 'write'); // Used by the include of actions_dellink.inc.php
$permissiontoadd = $user->hasRight('bom', 'write'); // Used by the include of actions_addupdatedelete.inc.php and actions_lineupdown.inc.php
$permissiontodelete = $user->hasRight('bom', 'delete') || ($permissiontoadd && isset($object->status) && $object->status == $object::STATUS_DRAFT);
$upload_dir = $conf->bom->multidir_output[isset($object->entity) ? $object->entity : 1];
 
 
/*
 * Actions
 */
 
$parameters = array();
$reshook = $hookmanager->executeHooks('doActions', $parameters, $object, $action); // Note that $action and $object may have been modified by some hooks
if ($reshook < 0) {
  setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
}
 
if (empty($reshook)) {
  $error = 0;
 
  $backurlforlist = DOL_URL_ROOT.'/bom/bom_list.php';
 
  if (empty($backtopage) || ($cancel && empty($id))) {
    if (empty($backtopage) || ($cancel && strpos($backtopage, '__ID__'))) {
      if (empty($id) && (($action != 'add' && $action != 'create') || $cancel)) {
        $backtopage = $backurlforlist;
      } else {
        $backtopage = DOL_URL_ROOT.'/bom/bom_net_needs.php?id='.($id > 0 ? $id : '__ID__');
      }
    }
  }
}
 
 
/*
 * View
 */
 
$form = new Form($db);
$formfile = new FormFile($db);
 
$title = $langs->trans('BOM');
$help_url = 'EN:Module_BOM';
 
llxHeader('', $title, $help_url, '', 0, 0, '', '', '', 'mod-bom page-net_needs');
 
 
$TChildBom = array();
if ($action == 'treeview') {
  $object->getNetNeedsTree($TChildBom, 1);
} else {
  $object->getNetNeeds($TChildBom, 1);
}
 
 
// Part to show record
if ($object->id > 0 && (empty($action) || ($action != 'edit' && $action != 'create'))) {
  $head = bomPrepareHead($object);
  print dol_get_fiche_head($head, 'net_needs', $langs->trans("BillOfMaterials"), -1, $object->picto);
 
  $formconfirm = '';
 
  // Call Hook formConfirm
  $parameters = array('formConfirm' => $formconfirm, 'lineid' => $lineid);
  $reshook = $hookmanager->executeHooks('formConfirm', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
  if (empty($reshook)) {
    $formconfirm .= $hookmanager->resPrint;
  } elseif ($reshook > 0) {
    $formconfirm = $hookmanager->resPrint;
  }
 
  // Print form confirm
  print $formconfirm;
 
 
  // Object card
  // ------------------------------------------------------------
  $linkback = '<a href="'.DOL_URL_ROOT.'/bom/bom_list.php?restore_lastsearch_values=1">'.$langs->trans("BackToList").'</a>';
 
  $morehtmlref = '<div class="refidno">';
 
  $morehtmlref .= '</div>';
 
 
  dol_banner_tab($object, 'ref', $linkback, 1, 'ref', 'ref', $morehtmlref);
 
 
  print '<div class="fichecenter">';
  print '<div class="fichehalfleft">';
  print '<div class="underbanner clearboth"></div>';
  print '<table class="border centpercent tableforfield">'."\n";
 
  // Common attributes
  $keyforbreak = 'duration';  // used into tpl
  include DOL_DOCUMENT_ROOT.'/core/tpl/commonfields_view.tpl.php';
 
  // Manufacturing cost
  print '<tr><td>'.$form->textwithpicto($langs->trans("ManufacturingCost"), $langs->trans("BOMTotalCost")).'</td><td><span class="amount">';
  print price($object->total_cost);
  print '</span>';
  if ($object->total_cost != $object->unit_cost) {
    print '&nbsp; &nbsp; <span class="opacitymedium">('.$form->textwithpicto(price($object->unit_cost), $langs->trans("ManufacturingUnitCost"), 1, 'help', '').')</span>';
  }
  print '</td></tr>';
 
  // Find sell price of generated product. We suppose we sell it to a company like ours (same country...).
  $res = $object->fetch_product();
  $manufacturedvalued = '';
  if ($res && is_object($object->product) && !$object->product->isEmpty()) {
    global $mysoc;
    $tmparray = $object->product->getSellPrice($mysoc, $mysoc);
    $manufacturedvalued = $tmparray['pu_ht'] * $object->qty;
  }
  print '<tr><td>'.$langs->trans("ManufacturingGeneratedValue").'</td><td>'.price($manufacturedvalued).'</td></tr>';
 
  // Other attributes
  include DOL_DOCUMENT_ROOT.'/core/tpl/extrafields_view.tpl.php';
 
  print '</table>';
  print '</div>';
  print '</div>';
 
  print '<div class="clearboth"></div>';
 
  print dol_get_fiche_end();
 
  $viewlink = dolGetButtonTitle($langs->trans('GroupByX', $langs->transnoentitiesnoconv("Products")), '', 'fa fa-bars imgforviewmode', $_SERVER['PHP_SELF'].'?id='.$object->id.'&token='.newToken(), '', 1, array('morecss' => 'reposition '.($action !== 'treeview' ? 'btnTitleSelected' : '')));
  $viewlink .= dolGetButtonTitle($langs->trans('TreeView'), '', 'fa fa-stream imgforviewmode', $_SERVER['PHP_SELF'].'?id='.$object->id.'&action=treeview&token='.newToken(), '', 1, array('morecss' => 'reposition marginleftonly '.($action == 'treeview' ? 'btnTitleSelected' : '')));
 
  print load_fiche_titre($langs->trans("BOMNetNeeds"), $viewlink, 'product');
 
  /*
   * Lines
   */
  $text_stock_options = $langs->trans("RealStockDesc").'<br>';
  $text_stock_options .= $langs->trans("RealStockWillAutomaticallyWhen").'<br>';
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_SHIPMENT') || getDolGlobalString('STOCK_CALCULATE_ON_SHIPMENT_CLOSE') ? '- '.$langs->trans("DeStockOnShipment").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_VALIDATE_ORDER') ? '- '.$langs->trans("DeStockOnValidateOrder").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_BILL') ? '- '.$langs->trans("DeStockOnBill").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_SUPPLIER_BILL') ? '- '.$langs->trans("ReStockOnBill").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_SUPPLIER_VALIDATE_ORDER') ? '- '.$langs->trans("ReStockOnValidateOrder").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_SUPPLIER_DISPATCH_ORDER') ? '- '.$langs->trans("ReStockOnDispatchOrder").'<br>' : '');
  $text_stock_options .= (getDolGlobalString('STOCK_CALCULATE_ON_RECEPTION') || getDolGlobalString('STOCK_CALCULATE_ON_RECEPTION_CLOSE') ? '- '.$langs->trans("StockOnReception").'<br>' : '');
 
  print '<table id="tablelines" class="noborder noshadow" width="100%">';
  print "<thead>\n";
  print '<tr class="liste_titre nodrag nodrop">';
  print '<td class="linecoldescription">'.$langs->trans('Product');
  if (getDolGlobalString('BOM_SUB_BOM')  && $action == 'treeview') {
    print ' &nbsp; <a id="show_all" href="#">'.img_picto('', 'folder-open', 'class="paddingright"').$langs->trans("ExpandAll").'</a>&nbsp;&nbsp;';
    print '<a id="hide_all" href="#">'.img_picto('', 'folder', 'class="paddingright"').$langs->trans("UndoExpandAll").'</a>&nbsp;';
  }
  print '</td>';
  if ($action == 'treeview') {
    print '<td class="left">'.$langs->trans('ProducedBy').'</td>';
  }
  print '<td class="linecolqty right">'.$langs->trans('Quantity').'</td>';
  print '<td></td>';  // For unit
  print '<td class="linecolstock right">'.$form->textwithpicto($langs->trans("PhysicalStock"), $text_stock_options, 1).'</td>';
  print '<td class="linecoltheoricalstock right">'.$form->textwithpicto($langs->trans("VirtualStock"), $langs->trans("VirtualStockDesc")).'</td>';
  print  '</tr>';
 
  print '</thead>';
  print '<tbody>';
  $tablerows = array();
  $position = '';
  $levelposition = '';
  $lineposition = 0;
  if (count($TChildBom) > 0) {
    if ($action == 'treeview') {
      foreach ($TChildBom as $fk_bom => $TProduct) {
        $repeatChar = '&emsp;';
        if (!empty($TProduct['bom'])) {
          // we make position string in format 'lineposition.bomlevel.childposition'
          if (!empty($TProduct['position']) && $TProduct['parentid'] == $object->id) {
            // define lineposition
            $lineposition = $TProduct['position'];
          }
          // define lineposition.bomlevel
          $position = sprintf('%d.%d', $lineposition, $TProduct['level']);
          // memorize level position for products in bom
          $levelposition = $position;
          if (!empty($TProduct['parentid']) && $TProduct['parentid'] != $object->id && empty($TProduct['product'])) {
            // define lineposition.bomlevel.childposition
            $position = sprintf('%s.%d', $position, $TProduct['position']);
          }
          $prod = new Product($db);
          $prod->fetch($TProduct['bom']->fk_product);
          if ($TProduct['parentid'] != $object->id) {
            $tablerows[$position] = '<tr class="sub_bom_lines oddeven" parentid="'.$TProduct['parentid'].'">';
          } else {
            $tablerows[$position] = '<tr class="oddeven">';
          }
          $tablerows[$position] .= '<td class="linecoldescription">'.str_repeat($repeatChar, $TProduct['level']).$prod->getNomUrl(1);
          $tablerows[$position] .= ' <a class="collapse_bom" id="collapse-'.$fk_bom.'" href="#">';
          $tablerows[$position] .= img_picto('', 'folder-open');
          $tablerows[$position] .= '</a>';
          $tablerows[$position] .=  '</td>';
          $tablerows[$position] .= '<td class="left">'.$TProduct['bom']->getNomUrl(1).'</td>';
          $tablerows[$position] .= '<td class="linecolqty right">'.price(price2num($TProduct['qty'], 'MS')).'</td>';
          $tablerows[$position] .= '<td>';
          $tablerows[$position] .= '</td>';
          $tablerows[$position] .= '<td class="linecolstock right"></td>';
          $tablerows[$position] .= '<td class="linecoltheoricalstock right"></td>';
          $tablerows[$position] .= '</tr>';
        }
        if (!empty($TProduct['product'])) {
          foreach ($TProduct['product'] as $fk_product => $TInfos) {
            if (!empty($TInfos['position']) && $fk_bom == $object->id) {
              // top level position
              $position = $TInfos['position'];
            } else {
              // sublevel position
              $position = sprintf('%s.%d', $levelposition, $TInfos['position']);
            }
            $prod = new Product($db);
            $prod->fetch($fk_product);
            $prod->load_virtual_stock();
            if (empty($prod->stock_reel)) {
              $prod->stock_reel = 0;
            }
            if ($fk_bom != $object->id) {
              $tablerows[$position] = '<tr class="sub_bom_lines oddeven" parentid="'.$fk_bom.'">'; // sub bom on same position
            } else {
              $tablerows[$position] = '<tr class="oddeven">';
            }
            $tablerows[$position] .= '<td class="linecoldescription">'.str_repeat($repeatChar, (int) $TInfos['level']).$prod->getNomUrl(1).'</td>';
            $tablerows[$position] .= '<td></td>';
            $tablerows[$position] .= '<td class="linecolqty right">'.price(price2num((float) $TInfos['qty'], 'MS')).'</td>';
            $tablerows[$position] .= '<td>';
            $tablerows[$position] .= '</td>';
            $tablerows[$position] .= '<td class="linecolstock right">'.price2num($prod->stock_reel, 'MS').'</td>';
            $tablerows[$position] .= '<td class="linecoltheoricalstock right">'.$prod->stock_theorique.'</td>';
            $tablerows[$position] .= '</tr>';
          }
        }
      }
      // Sort the rows numeric by position string
      ksort($tablerows, SORT_NUMERIC);
      // Print the rows
      foreach ($tablerows as $position => $row) {
        print $row;
      }
    } else {
      foreach ($TChildBom as $fk_product => $elem) {
        $prod = new Product($db);
        $prod->fetch($fk_product);
        $prod->load_virtual_stock();
        if (empty($prod->stock_reel)) {
          $prod->stock_reel = 0;
        }
        print '<tr class="oddeven">';
        print '<td class="linecoldescription">'.$prod->getNomUrl(1).'</td>';
        print '<td class="linecolqty right">'.price(price2num($elem['qty'], 'MS')).'</td>';
        print '<td>';
        $useunit = (($prod->type == Product::TYPE_PRODUCT && getDolGlobalInt('PRODUCT_USE_UNITS')) || (($prod->type == Product::TYPE_SERVICE) && ($elem['fk_unit'])));
        if ($useunit) {
          require_once DOL_DOCUMENT_ROOT.'/core/class/cunits.class.php';
          $unit = new CUnits($db);
          $unit->fetch((int) $elem['fk_unit']);
          print(isset($unit->label) ? "&nbsp;".$langs->trans(ucwords((string) $unit->label))."&nbsp;" : '');
        }
        print '</td>';
        print '<td class="linecolstock right">'.price(price2num($prod->stock_reel, 'MS')).'</td>';
        print '<td class="linecoltheoricalstock right">'.$prod->stock_theorique.'</td>';
        print '</tr>';
      }
    }
  }
  print '</tbody>';
  print '</table>';
 
 
 
  /*
   * ButAction
   */
  print '<div class="tabsAction">'."\n";
  $parameters = array();
  $reshook = $hookmanager->executeHooks('addMoreActionsButtons', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
  if ($reshook < 0) {
    setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
  }
  print '</div>'; ?>
 
    <script type="text/javascript" language="javascript">
      $(document).ready(function() {
 
        function folderManage(element) {
          var id_bom_line = element.attr('id').replace('collapse-', '');
          let TSubLines = $('[parentid="'+ id_bom_line +'"]');
 
          if(element.html().indexOf('folder-open') <= 0) {
            $('[parentid="'+ id_bom_line +'"]').show();
            element.html('<?php echo dol_escape_js(img_picto('', 'folder-open')); ?>');
          }
          else {
            for (let i = 0; i < TSubLines.length; i++) {
              let subBomFolder = $(TSubLines[i]).children('.linecoldescription').children('.collapse_bom');
              if (subBomFolder.length > 0) {
                folderManage(subBomFolder);
              }
            }
            TSubLines.hide();
            element.html('<?php echo dol_escape_js(img_picto('', 'folder')); ?>');
          }
        }
 
        // When clicking on collapse
        $(".collapse_bom").click(function() {
          folderManage($(this));
          return false;
        });
 
        // To Show all the sub bom lines
        $("#show_all").click(function() {
          console.log("We click on show all");
          $("[class^=sub_bom_lines]").show();
          $("[class^=collapse_bom]").html('<?php echo dol_escape_js(img_picto('', 'folder-open')); ?>');
          return false;
        });
 
        // To Hide all the sub bom lines
        $("#hide_all").click(function() {
          console.log("We click on hide all");
          $("[class^=sub_bom_lines]").hide();
          $("[class^=collapse_bom]").html('<?php echo dol_escape_js(img_picto('', 'folder')); ?>');
          return false;
        });
 
      });
    </script>
 
    <?php
}
 
// End of page
llxFooter();
$db->close();