DoliModules\Bom\Model\BomLine

Complexity

Total Complexity

55

Size/Duplication

Total Lines	470
Duplicated Lines	0 %

Importance

Changes

0

11 Methods

Rating	Name	Duplication	Size	Complexity
F	getNomUrl()	0	64	21
A	LibStatut()	0	4	1
B	fetchAll()	0	50	7
A	fetch()	0	5	1
A	info()	0	21	4
A	getLibStatut()	0	3	1
A	update()	0	7	3
A	delete()	0	3	1
A	create()	0	7	3
A	initAsSpecimen()	0	3	1
C	__construct()	0	25	12

<?php

/* Copyright (C) 2019       Laurent Destailleur     <eldy@users.sourceforge.net>
 * Copyright (C) 2023	    Benjamin Falière	    <benjamin.faliere@altairis.fr>
 * Copyright (C) 2023	    Charlene Benke		    <charlene@patas-monkey.com>
 * Copyright (C) 2024       Frédéric France         <frederic.france@free.fr>
 * Copyright (C) 2024		MDW						<mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Rafael San José         <rsanjose@alxarafe.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/>.
 */

/**
 * \file        htdocs/bom/class/bom.class.php
 * \ingroup     bom
 * \brief       This file is a CRUD class file for BOM (Create/Read/Update/Delete)
 */

namespace DoliModules\Bom\Model;

use DoliCore\Base\GenericDocumentLine;
use DoliDB;
use User;

require_once BASE_PATH . '/../Dolibarr/Lib/Date.php';

if (isModEnabled('workstation')) {
    require_once DOL_DOCUMENT_ROOT . '/workstation/class/workstation.class.php';
}

/**
 * Class for BOMLine
 */
class BomLine extends GenericDocumentLine
{
    /**
     * @var string ID to identify managed object
     */
    public $element = 'bomline';

    /**
     * @var string Name of table without prefix where object is stored
     */
    public $table_element = 'bom_bomline';

    /**
     * @var int  Does bomline support multicompany module ? 0=No test on entity, 1=Test with field entity, 2=Test with
     *      link by societe
     */
    public $ismultientitymanaged = 0;

    /**
     * @var int  Does bomline support extrafields ? 0=No, 1=Yes
     */
    public $isextrafieldmanaged = 1;

    /**
     * @var string String with name of icon for bomline. Must be the part after the 'object_' into object_bomline.png
     */
    public $picto = 'bomline';


    /**
     *  'type' if the field format.
     *  'label' the translation key.
     *  'enabled' is a condition when the field must be managed.
     *  'visible' says if field is visible in list (Examples: 0=Not visible, 1=Visible on list and create/update/view
     *  forms, 2=Visible on list only. Using a negative value means field is not shown by default on list but can be
     *  selected for viewing)
     *  'notnull' is set to 1 if not null in database. Set to -1 if we must set data to null if empty ('' or 0).
     *  'default' is a default value for creation (can still be replaced by the global setup of default values)
     *  'index' if we want an index in database.
     *  'foreignkey'=>'tablename.field' if the field is a foreign key (it is recommended to name the field fk_...).
     *  'position' is the sort order of field.
     *  'searchall' is 1 if we want to search in this field when making a search from the quick search button.
     *  'isameasure' must be set to 1 if you want to have a total on list for this field. Field type must be summable
     *  like integer or double(24,8).
     *  'css' is the CSS style to use on field. For example: 'maxwidth200'
     *  'help' is a string visible as a tooltip on field
     *  'comment' is not used. You can store here any text of your choice. It is not used by application.
     *  'showoncombobox' if value of the field must be visible into the label of the combobox that list record
     *  'arrayofkeyval' to set list of value if type is a list of predefined values. For example:
     *  array("0"=>"Draft","1"=>"Active","-1"=>"Cancel")
     */

    // BEGIN MODULEBUILDER PROPERTIES
    /**
     * @var array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}>

The doc comment array<string,array{type:string,label:string,enabled:int<0,2>|string,position:int,notnull:int,visible:int,noteditable?:int,default?:string,index?:int,foreignkey?:string,searchall?:int,isameasure?:int,css?:string,csslist?:string,help?:string,showoncombobox?:int,disabled?:int,arrayofkeyval?:array<int,string>,comment?:string}> at position 16 could not be parsed: Expected '}' at position 16, but found 'int'.

     *      Array with all fields and their property. Do not use it as a static var. It may be modified by constructor.
     */
    public $fields = [
        'rowid' => ['type' => 'integer', 'label' => 'LineID', 'enabled' => 1, 'visible' => -1, 'position' => 1, 'notnull' => 1, 'index' => 1, 'comment' => "Id",],
        'fk_bom' => ['type' => 'integer:BillOfMaterials:societe/class/bom.class.php', 'label' => 'BillOfMaterials', 'enabled' => 1, 'visible' => 1, 'position' => 10, 'notnull' => 1, 'index' => 1,],
        'fk_product' => ['type' => 'integer:Product:product/class/product.class.php', 'label' => 'Product', 'enabled' => 1, 'visible' => 1, 'position' => 20, 'notnull' => 1, 'index' => 1,],
        'fk_bom_child' => ['type' => 'integer:BOM:bom/class/bom.class.php', 'label' => 'BillOfMaterials', 'enabled' => 1, 'visible' => -1, 'position' => 40, 'notnull' => -1,],
        'description' => ['type' => 'text', 'label' => 'Description', 'enabled' => 1, 'visible' => -1, 'position' => 60, 'notnull' => -1,],
        'qty' => ['type' => 'double(24,8)', 'label' => 'Quantity', 'enabled' => 1, 'visible' => 1, 'position' => 100, 'notnull' => 1, 'isameasure' => 1,],
        'qty_frozen' => ['type' => 'smallint', 'label' => 'QuantityFrozen', 'enabled' => 1, 'visible' => 1, 'default' => '0', 'position' => 105, 'css' => 'maxwidth50imp', 'help' => 'QuantityConsumedInvariable'],
        'disable_stock_change' => ['type' => 'smallint', 'label' => 'DisableStockChange', 'enabled' => 1, 'visible' => 1, 'default' => '0', 'position' => 108, 'css' => 'maxwidth50imp', 'help' => 'DisableStockChangeHelp'],
        'efficiency' => ['type' => 'double(24,8)', 'label' => 'ManufacturingEfficiency', 'enabled' => 1, 'visible' => 0, 'default' => '1', 'position' => 110, 'notnull' => 1, 'css' => 'maxwidth50imp', 'help' => 'ValueOfEfficiencyConsumedMeans'],
        'fk_unit' => ['type' => 'integer', 'label' => 'Unit', 'enabled' => 1, 'visible' => 1, 'position' => 120, 'notnull' => -1,],
        'position' => ['type' => 'integer', 'label' => 'Rank', 'enabled' => 1, 'visible' => 0, 'default' => '0', 'position' => 200, 'notnull' => 1,],
        'import_key' => ['type' => 'varchar(14)', 'label' => 'ImportId', 'enabled' => 1, 'visible' => -2, 'position' => 1000, 'notnull' => -1,],
        'fk_default_workstation' => ['type' => 'integer', 'label' => 'DefaultWorkstation', 'enabled' => 1, 'visible' => 1, 'notnull' => 0, 'position' => 1050],
    ];

    /**
     * @var int rowid
     */
    public $rowid;

    /**
     * @var int fk_bom
     */
    public $fk_bom;

    /**
     * @var int Id of product
     */
    public $fk_product;

    /**
     * @var int Id of parent bom
     */
    public $fk_bom_child;

    /**
     * @var string description
     */
    public $description;

    /**
     * @var double qty
     */
    public $qty;

    /**
     * @var int qty frozen
     */
    public $qty_frozen;

    /**
     * @var int disable stock change
     */
    public $disable_stock_change;

    /**
     * @var double efficiency
     */
    public $efficiency;

    /**
     * @var int position of line
     */
    public $position;

    /**
     * @var string import key
     */
    public $import_key;
    // END MODULEBUILDER PROPERTIES

    /**
     * @var float       Calculated cost for the BOM line
     */
    public $total_cost = 0;

    /**
     * @var float       Line unit cost based on product cost price or pmp
     */
    public $unit_cost = 0;

    /**
     * @var array     array of Bom in line
     */
    public $childBom = [];

    /**
     * @var int|null                ID of the unit of measurement (rowid in llx_c_units table)
     * @see measuringUnitString()
     * @see getLabelOfUnit()
     */
    public $fk_unit;

    /**
     * @var int Service Workstation
     */
    public $fk_default_workstation;


    /**
     * Constructor
     *
     * @param DoliDB $db Database handler
     */
    public function __construct(DoliDB $db)
    {
        global $conf, $langs;

        $this->db = $db;

        if (!getDolGlobalString('MAIN_SHOW_TECHNICAL_ID') && isset($this->fields['rowid'])) {
            $this->fields['rowid']['visible'] = 0;
        }
        if (!isModEnabled('multicompany') && isset($this->fields['entity'])) {
            $this->fields['entity']['enabled'] = 0;
        }

        // Unset fields that are disabled
        foreach ($this->fields as $key => $val) {
            if (isset($val['enabled']) && empty($val['enabled'])) {
                unset($this->fields[$key]);
            }
        }

        // Translate some data of arrayofkeyval
        foreach ($this->fields as $key => $val) {
            if (!empty($val['arrayofkeyval']) && is_array($val['arrayofkeyval'])) {
                foreach ($val['arrayofkeyval'] as $key2 => $val2) {
                    $this->fields[$key]['arrayofkeyval'][$key2] = $langs->trans($val2);
                }
            }
        }
    }

    /**
     * Create object into database
     *
     * @param User $user      User that creates
     * @param int  $notrigger 0=launch triggers after, 1=disable triggers
     *
     * @return int             Return integer <0 if KO, Id of created object if OK
     */
    public function create(User $user, $notrigger = 0)
    {
        if ($this->efficiency < 0 || $this->efficiency > 1) {
            $this->efficiency = 1;
        }

        return $this->createCommon($user, $notrigger);
    }

    /**
     * Load object in memory from the database
     *
     * @param int    $id  Id object
     * @param string $ref Ref
     *
     * @return int         Return integer <0 if KO, 0 if not found, >0 if OK
     */
    public function fetch($id, $ref = null)
    {
        $result = $this->fetchCommon($id, $ref);
        //if ($result > 0 && !empty($this->table_element_line)) $this->fetchLines();
        return $result;
    }

    /**
     * Load list of objects in memory from the database.
     *
     * @param string $sortorder             Sort Order
     * @param string $sortfield             Sort field
     * @param int    $limit                 limit
     * @param int    $offset                Offset
     * @param string $filter                Filter as an Universal Search string.
     *                                      Example: '((client:=:1) OR ((client:>=:2) AND (client:<=:3))) AND
     *                                      (client:!=:8) AND (nom:like:'a%')'
     * @param string $filtermode            No more used
     *
     * @return array|int                    int <0 if KO, array of pages if OK
     */
    public function fetchAll($sortorder = '', $sortfield = '', $limit = 0, $offset = 0, $filter = '', $filtermode = 'AND')
    {
        dol_syslog(__METHOD__, LOG_DEBUG);

        $records = [];

        $sql = 'SELECT ';
        $sql .= $this->getFieldList();
        $sql .= ' FROM ' . MAIN_DB_PREFIX . $this->table_element . ' as t';
        if ($this->ismultientitymanaged) {
            $sql .= ' WHERE t.entity IN (' . getEntity($this->element) . ')';
        } else {
            $sql .= ' WHERE 1 = 1';
        }

        // Manage filter
        $errormessage = '';
        $sql .= forgeSQLFromUniversalSearchCriteria($filter, $errormessage);
        if ($errormessage) {
            $this->errors[] = $errormessage;
            dol_syslog(__METHOD__ . ' ' . implode(',', $this->errors), LOG_ERR);
            return -1;
        }

        if (!empty($sortfield)) {
            $sql .= $this->db->order($sortfield, $sortorder);
        }
        if (!empty($limit)) {
            $sql .= $this->db->plimit($limit, $offset);
        }

        $resql = $this->db->query($sql);
        if ($resql) {
            $num = $this->db->num_rows($resql);

            while ($obj = $this->db->fetch_object($resql)) {
                $record = new self($this->db);
                $record->setVarsFromFetchObj($obj);
                $record->fetch_optionals();

                $records[$record->id] = $record;
            }
            $this->db->free($resql);

            return $records;
        } else {
            $this->errors[] = 'Error ' . $this->db->lasterror();
            dol_syslog(__METHOD__ . ' ' . implode(',', $this->errors), LOG_ERR);

            return -1;
        }
    }

    /**
     * Update object into database
     *
     * @param User $user      User that modifies
     * @param int  $notrigger 0=launch triggers after, 1=disable triggers
     *
     * @return int             Return integer <0 if KO, >0 if OK
     */
    public function update(User $user, $notrigger = 0)
    {
        if ($this->efficiency < 0 || $this->efficiency > 1) {
            $this->efficiency = 1;
        }

        return $this->updateCommon($user, $notrigger);
    }

    /**
     * Delete object in database
     *
     * @param User $user      User that deletes
     * @param int  $notrigger 0=launch triggers after, 1=disable triggers
     *
     * @return int              Return integer <0 if KO, >0 if OK
     */
    public function delete(User $user, $notrigger = 0)
    {
        return $this->deleteCommon($user, $notrigger);
        //return $this->deleteCommon($user, $notrigger, 1);
    }

    /**
     *  Return a link to the object card (with optionally the picto)
     *
     * @param int    $withpicto             Include picto in link (0=No picto, 1=Include picto into link, 2=Only picto)
     * @param string $option                On what the link point to ('nolink', ...)
     * @param int    $notooltip             1=Disable tooltip
     * @param string $morecss               Add more css on link
     * @param int    $save_lastsearch_value -1=Auto, 0=No save of lastsearch_values when clicking, 1=Save
     *                                      lastsearch_values whenclicking
     *
     * @return string                              String with URL
     */
    public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
    {
        global $db, $conf, $langs, $hookmanager;

        if (!empty($conf->dol_no_mouse_hover)) {
            $notooltip = 1; // Force disable tooltips
        }

        $result = '';

        $label = '<u>' . $langs->trans("BillOfMaterialsLine") . '</u>';
        $label .= '<br>';
        $label .= '<b>' . $langs->trans('Ref') . ':</b> ' . $this->ref;

        $url = DOL_URL_ROOT . '/bom/bomline_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("ShowBillOfMaterialsLine");
                $linkclose .= ' alt="' . dol_escape_htmltag($label, 1) . '"';
            }
            $linkclose .= ' title="' . dol_escape_htmltag($label, 1) . '"';
            $linkclose .= ' class="classfortooltip' . ($morecss ? ' ' . $morecss : '') . '"';
        } else {
            $linkclose = ($morecss ? ' class="' . $morecss . '"' : '');
        }

        $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 ' : '') . 'classfortooltip"'), 0, 0, $notooltip ? 0 : 1);
        }
        if ($withpicto != 2) {
            $result .= $this->ref;
        }
        $result .= $linkend;
        //if ($withpicto != 2) $result.=(($addlabel && $this->label) ? $sep . dol_trunc($this->label, ($addlabel > 1 ? $addlabel : 0)) : '');

        global $action, $hookmanager;
        $hookmanager->initHooks(['bomlinedao']);
        $parameters = ['id' => $this->id, 'getnomurl' => &$result];
        $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;
    }

    /**
     *  Return label of the status
     *
     * @param int $mode 0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short
     *                  label + Picto, 6=Long label + Picto
     *
     * @return string                 Label of status
     */
    public function getLibStatut($mode = 0)
    {
        return $this->LibStatut($this->status, $mode);
    }

    // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps

    /**
     *  Return the status
     *
     * @param int $status Id status
     * @param int $mode   0=long label, 1=short label, 2=Picto + short label, 3=Picto, 4=Picto + long label, 5=Short
     *                    label + Picto, 6=Long label + Picto
     *
     * @return string                 Label of status
     */
    public function LibStatut($status, $mode = 0)
    {
        // phpcs:enable
        return '';
    }

    /**
     *  Load the info information in the object
     *
     * @param int $id Id of object
     *
     * @return void
     */
    public function info($id)
    {
        $sql = 'SELECT rowid, date_creation as datec, tms as datem,';
        $sql .= ' fk_user_creat, fk_user_modif';
        $sql .= ' FROM ' . MAIN_DB_PREFIX . $this->table_element . ' as t';
        $sql .= ' WHERE t.rowid = ' . ((int) $id);
        $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_creat;
                $this->user_modification_id = $obj->fk_user_modif;
                $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);
        }
    }

    /**
     * Initialise object with example values
     * Id must be 0 if object instance is a specimen
     *
     * @return int
     */
    public function initAsSpecimen()
    {
        return $this->initAsSpecimenCommon();
    }
}