inventory.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2007-2019  Laurent Destailleur <eldy@users.sourceforge.net>
 * Copyright (C) 2014-2016  Juanjo Menent       <jmenent@2byte.es>
 * Copyright (C) 2015       Florian Henry       <florian.henry@open-concept.pro>
 * Copyright (C) 2015       Raphaël Doursenaud  <rdoursenaud@gpcsolutions.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/>.
 */

// Put here all includes required by your class file
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobjectline.class.php';
//require_once DOL_DOCUMENT_ROOT . '/societe/class/societe.class.php';
//require_once DOL_DOCUMENT_ROOT . '/product/class/product.class.php';

class Inventory extends CommonObject
{
  public $element = 'inventory';

  public $table_element = 'inventory';

  public $ismultientitymanaged = 1;

  public $isextrafieldmanaged = 0;

  public $picto = 'inventory';

  const STATUS_DRAFT = 0;     // Draft
  const STATUS_VALIDATED = 1;   // Inventory is in process
  const STATUS_RECORDED = 2;    // Inventory is finisged. Stock movement has been recorded.
  const STATUS_CANCELED = 9;    // Canceled

  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type'=>'integer', 'label'=>'TechnicalID', 'visible'=>-1, 'enabled'=>1, 'position'=>1, 'notnull'=>1, 'index'=>1, 'comment'=>'Id',),
    'ref' => array('type'=>'varchar(64)', 'label'=>'Ref', 'visible'=>1, 'enabled'=>1, 'position'=>10, 'notnull'=>1, 'index'=>1, 'searchall'=>1, 'comment'=>'Reference of object', 'css'=>'maxwidth200'),
    'entity'         => array('type'=>'integer', 'label'=>'Entity', 'visible'=>0, 'enabled'=>1, 'position'=>20, 'notnull'=>1, 'index'=>1,),
    'title'          => array('type'=>'varchar(255)', 'label'=>'Label', 'visible'=>1, 'enabled'=>1, 'position'=>25, 'css'=>'minwidth300', 'csslist'=>'tdoverflowmax200'),
    'fk_warehouse'   => array('type'=>'integer:Entrepot:product/stock/class/entrepot.class.php', 'label'=>'Warehouse', 'visible'=>1, 'enabled'=>1, 'position'=>30, 'index'=>1, 'help'=>'InventoryForASpecificWarehouse', 'picto'=>'stock', 'css'=>'minwidth300 maxwidth500 widthcentpercentminusx', 'csslist'=>'tdoverflowmax200'),
    'fk_product'     => array('type'=>'integer:Product:product/class/product.class.php', 'label'=>'Product', 'visible'=>1, 'enabled'=>1, 'position'=>32, 'index'=>1, 'help'=>'InventoryForASpecificProduct', 'picto'=>'product', 'css'=>'minwidth300 maxwidth500 widthcentpercentminusx', 'csslist'=>'tdoverflowmax200'),
    'date_inventory' => array('type'=>'date', 'label'=>'DateValue', 'visible'=>1, 'enabled'=>'$conf->global->STOCK_INVENTORY_ADD_A_VALUE_DATE', 'position'=>35),  // This date is not used so disabled by default.
    'date_creation' => array('type'=>'datetime', 'label'=>'DateCreation', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>500),
    'tms'           => array('type'=>'timestamp', 'label'=>'DateModification', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>501),
    'date_validation' => array('type'=>'datetime', 'label'=>'DateValidation', 'visible'=>-2, 'enabled'=>1, 'position'=>502),
    'fk_user_creat' => array('type'=>'integer:User:user/class/user.class.php', 'label'=>'UserAuthor', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>510, 'foreignkey'=>'user.rowid', 'csslist'=>'tdoverflowmax200'),
    'fk_user_modif' => array('type'=>'integer:User:user/class/user.class.php', 'label'=>'UserModif', 'enabled'=>1, 'visible'=>-2, 'notnull'=>-1, 'position'=>511, 'csslist'=>'tdoverflowmax200'),
    'fk_user_valid' => array('type'=>'integer:User:user/class/user.class.php', 'label'=>'UserValidation', 'visible'=>-2, 'enabled'=>1, 'position'=>512, 'csslist'=>'tdoverflowmax200'),
    'import_key'    => array('type'=>'varchar(14)', 'label'=>'ImportId', 'enabled'=>1, 'visible'=>-2, 'notnull'=>-1, 'index'=>0, 'position'=>1000),

    'status' => array('type'=>'integer', 'label'=>'Status', 'visible'=>4, 'enabled'=>1, 'position'=>1000, 'notnull'=>1, 'default'=>0, 'index'=>1, 'arrayofkeyval'=>array(0=>'Draft', 1=>'Validated', 2=>'Closed', 9=>'Canceled'))
  );

  public $rowid;

  public $ref;

  public $entity;

  public $fk_warehouse;

  public $fk_product;

  public $date_inventory;
  public $title;

  public $status;

  public $date_creation;

  public $date_validation;


  public $tms;

  public $fk_user_creat;

  public $fk_user_modif;

  public $fk_user_valid;

  public $import_key;
  // END MODULEBUILDER PROPERTIES



  // If this object has a subtable with lines

  public $table_element_line = 'inventorydet';

  public $fk_element = 'fk_inventory';

  public $class_element_line = 'Inventoryline';

  protected $childtables = array();
  protected $childtablesoncascade = array('inventorydet');

  public $lines = array();



  public function __construct(DoliDB $db)
  {
    global $conf;

    $this->db = $db;

    if (empty($conf->global->MAIN_SHOW_TECHNICAL_ID)) {
      $this->fields['rowid']['visible'] = 0;
    }
    if (empty($conf->multicompany->enabled)) {
      $this->fields['entity']['enabled'] = 0;
    }
  }


  public function create(User $user, $notrigger = false)
  {
    $result = $this->createCommon($user, $notrigger);

    return $result;
  }

  public function validate(User $user, $notrigger = false)
  {
    global $conf;
    $this->db->begin();

    $result = 0;

    if ($this->status == self::STATUS_DRAFT) {
      // Delete inventory
      $sql = 'DELETE FROM '.$this->db->prefix().'inventorydet WHERE fk_inventory = '.((int) $this->id);
      $resql = $this->db->query($sql);
      if (!$resql) {
        $this->error = $this->db->lasterror();
        $this->db->rollback();
        return -1;
      }

      // Scan existing stock to prefill the inventory
      $sql = "SELECT ps.rowid, ps.fk_entrepot as fk_warehouse, ps.fk_product, ps.reel,";
      $sql .= " pb.batch, pb.qty";
      $sql .= " FROM ".$this->db->prefix()."product_stock as ps";
      $sql .= " LEFT JOIN ".$this->db->prefix()."product_batch as pb ON pb.fk_product_stock = ps.rowid,";
      $sql .= " ".$this->db->prefix()."product as p, ".$this->db->prefix()."entrepot as e";
      $sql .= " WHERE p.entity IN (".getEntity('product').")";
      $sql .= " AND ps.fk_product = p.rowid AND ps.fk_entrepot = e.rowid";
      if (empty($conf->global->STOCK_SUPPORTS_SERVICES)) {
        $sql .= " AND p.fk_product_type = 0";
      }
      if ($this->fk_product > 0) {
        $sql .= " AND ps.fk_product = ".((int) $this->fk_product);
      }
      if ($this->fk_warehouse > 0) {
        $sql .= " AND ps.fk_entrepot = ".((int) $this->fk_warehouse);
      }

      $inventoryline = new InventoryLine($this->db);

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

        $i = 0;
        while ($i < $num) {
          $obj = $this->db->fetch_object($resql);

          $inventoryline->fk_inventory = $this->id;
          $inventoryline->fk_warehouse = $obj->fk_warehouse;
          $inventoryline->fk_product = $obj->fk_product;
          $inventoryline->batch = $obj->batch;
          $inventoryline->datec = dol_now();

          if (isModEnabled('productbatch')) {
            $inventoryline->qty_stock = ($obj->batch ? $obj->qty : $obj->reel); // If there is batch detail, we take qty for batch, else global qty
          } else {
            $inventoryline->qty_stock = $obj->reel;
          }

          $resultline = $inventoryline->create($user);
          if ($resultline <= 0) {
            $this->error = $inventoryline->error;
            $this->errors = $inventoryline->errors;
            $result = -1;
            break;
          }

          $i++;
        }
      } else {
        $result = -1;
        $this->error = $this->db->lasterror();
      }
    }

    if ($result >= 0) {
      $result = $this->setStatut($this::STATUS_VALIDATED, null, '', 'INVENTORY_VALIDATED');
    }

    if ($result > 0) {
      $this->db->commit();
    } else {
      $this->db->rollback();
    }
    return $result;
  }

  public function setDraft(User $user, $notrigger = false)
  {
    $this->db->begin();

    // Delete inventory
    $sql = 'DELETE FROM '.$this->db->prefix().'inventorydet WHERE fk_inventory = '.((int) $this->id);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->error = $this->db->lasterror();
      $this->db->rollback();
      return -1;
    }

    $result = $this->setStatut($this::STATUS_DRAFT, null, '', 'INVENTORY_DRAFT');

    if ($result > 0) {
      $this->db->commit();
    } else {
      $this->db->rollback();
    }
    return $result;
  }

  public function setRecorded(User $user, $notrigger = false)
  {
    $this->db->begin();

    $result = $this->setStatut($this::STATUS_RECORDED, null, '', 'INVENTORY_RECORDED');

    if ($result > 0) {
      $this->db->commit();
    } else {
      $this->db->rollback();
      return -1;
    }
    return $result;
  }

  public function setCanceled(User $user, $notrigger = false)
  {
    $this->db->begin();

    $result = $this->setStatut($this::STATUS_CANCELED, null, '', 'INVENTORY_CANCELED');

    if ($result > 0) {
      $this->db->commit();
    } else {
      $this->db->rollback();
      return -1;
    }
    return $result;
  }

  public function createFromClone(User $user, $fromid)
  {
    global $hookmanager, $langs;
    $error = 0;

    dol_syslog(__METHOD__, LOG_DEBUG);

    $object = new self($this->db);

    $this->db->begin();

    // Load source object
    $object->fetchCommon($fromid);
    // Reset some properties
    unset($object->id);
    unset($object->fk_user_creat);
    unset($object->import_key);

    // Clear fields
    $object->ref = "copy_of_".$object->ref;
    $object->title = $langs->trans("CopyOf")." ".$object->title;
    // ...

    // Create clone
    $object->context['createfromclone'] = 'createfromclone';
    $result = $object->createCommon($user);
    if ($result < 0) {
      $error++;
      $this->error = $object->error;
      $this->errors = $object->errors;
    }

    unset($object->context['createfromclone']);

    // End
    if (!$error) {
      $this->db->commit();
      return $object;
    } else {
      $this->db->rollback();
      return -1;
    }
  }

  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    //if ($result > 0 && ! empty($this->table_element_line)) $this->fetchLines();
    return $result;
  }

  /*public function fetchLines()
   {
   $this->lines=array();

   // Load lines with object MyObjectLine

   return count($this->lines)?1:0;
   }*/

  public function update(User $user, $notrigger = false)
  {
    return $this->updateCommon($user, $notrigger);
  }

  public function delete(User $user, $notrigger = false)
  {
    return $this->deleteCommon($user, $notrigger);
  }

  public function deleteLine(User $user, $idline, $notrigger = false)
  {
    if ($this->status < 0) {
      $this->error = 'ErrorDeleteLineNotAllowedByObjectStatus';
      return -2;
    }

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

  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $db, $conf, $langs;
    global $dolibarr_main_authentication, $dolibarr_main_demo;
    global $menumanager;

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

    $result = '';
    $companylink = '';

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

    $url = dol_buildpath('/product/inventory/card.php', 1).'?id='.$this->id;

    $linkclose = '';
    if (empty($notooltip)) {
      if (!empty($conf->global->MAIN_OPTIMIZEFORTEXTBROWSER)) {
        $label = $langs->trans("ShowInventory");
        $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)) : '');

    return $result;
  }

  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut($this->status, $mode);
  }

  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public static function LibStatut($status, $mode = 0)
  {
    // phpcs:enable
    global $langs;

    $labelStatus = array();
    $labelStatus[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
    $labelStatus[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('Validated').' ('.$langs->transnoentitiesnoconv('InventoryStartedShort').')';
    $labelStatus[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Canceled');
    $labelStatus[self::STATUS_RECORDED] = $langs->transnoentitiesnoconv('Closed');
    $labelStatusShort[self::STATUS_DRAFT] = $langs->transnoentitiesnoconv('Draft');
    $labelStatusShort[self::STATUS_VALIDATED] = $langs->transnoentitiesnoconv('InventoryStartedShort');
    $labelStatusShort[self::STATUS_CANCELED] = $langs->transnoentitiesnoconv('Canceled');
    $labelStatusShort[self::STATUS_RECORDED] = $langs->transnoentitiesnoconv('Closed');

    $statusType = 'status'.$status;
    if ($status == self::STATUS_RECORDED) {
      $statusType = 'status6';
    }

    return dolGetStatus($labelStatus[$status], $labelStatusShort[$status], '', $statusType, $mode);
  }

  public function info($id)
  {
    $sql = "SELECT rowid, date_creation as datec, tms as datem, date_validation as datev,";
    $sql .= " fk_user_creat, fk_user_modif, fk_user_valid";
    $sql .= " FROM ".$this->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;

        if ($obj->fk_user_creat > 0) {
          $cuser = new User($this->db);
          $cuser->fetch($obj->fk_user_creat);
          $this->user_creation = $cuser;
        }

        if ($obj->fk_user_modif > 0) {
          $muser = new User($this->db);
          $muser->fetch($obj->fk_user_modif);
          $this->user_creation = $muser;
        }

        if ($obj->fk_user_valid > 0) {
          $vuser = new User($this->db);
          $vuser->fetch($obj->fk_user_valid);
          $this->user_validation = $vuser;
        }

        $this->date_creation     = $this->db->jdate($obj->datec);
        $this->date_modification = $this->db->jdate($obj->datem);
        $this->date_validation   = $this->db->jdate($obj->datev);
      }

      $this->db->free($result);
    } else {
      dol_print_error($this->db);
    }
  }

  public function initAsSpecimen()
  {
    $this->initAsSpecimenCommon();
    $this->title = '';
  }
}

class InventoryLine extends CommonObjectLine
{
  public $element = 'inventoryline';

  public $table_element = 'inventorydet';

  public $ismultientitymanaged = 0;

  public $isextrafieldmanaged = 0;

  public $picto = 'stock';

  // BEGIN MODULEBUILDER PROPERTIES
  public $fields = array(
    'rowid' => array('type'=>'integer', 'label'=>'TechnicalID', 'visible'=>-1, 'enabled'=>1, 'position'=>1, 'notnull'=>1, 'index'=>1, 'comment'=>'Id',),
    'fk_inventory'  => array('type'=>'integer:Inventory:product/inventory/class/inventory.class.php', 'label'=>'Inventory', 'visible'=>1, 'enabled'=>1, 'position'=>30, 'index'=>1, 'help'=>'LinkToInventory'),
    'fk_warehouse'  => array('type'=>'integer:Entrepot:product/stock/class/entrepot.class.php', 'label'=>'Warehouse', 'visible'=>1, 'enabled'=>1, 'position'=>30, 'index'=>1, 'help'=>'LinkToThirparty'),
    'fk_product'    => array('type'=>'integer:Product:product/class/product.class.php', 'label'=>'Product', 'visible'=>1, 'enabled'=>1, 'position'=>32, 'index'=>1, 'help'=>'LinkToProduct'),
    'batch'         => array('type'=>'string', 'label'=>'Batch', 'visible'=>1, 'enabled'=>1, 'position'=>32, 'index'=>1, 'help'=>'LinkToProduct'),
    'datec'         => array('type'=>'datetime', 'label'=>'DateCreation', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>500),
    'tms'           => array('type'=>'timestamp', 'label'=>'DateModification', 'enabled'=>1, 'visible'=>-2, 'notnull'=>1, 'position'=>501),
    'qty_stock'     => array('type'=>'double', 'label'=>'QtyFound', 'visible'=>1, 'enabled'=>1, 'position'=>32, 'index'=>1, 'help'=>'Qty we found/want (to define during draft edition)'),
    'qty_view'      => array('type'=>'double', 'label'=>'QtyBefore', 'visible'=>1, 'enabled'=>1, 'position'=>33, 'index'=>1, 'help'=>'Qty before (filled once movements are validated)'),
    'qty_regulated' => array('type'=>'double', 'label'=>'QtyDelta', 'visible'=>1, 'enabled'=>1, 'position'=>34, 'index'=>1, 'help'=>'Qty aadded or removed (filled once movements are validated)'),
    'pmp_real' => array('type'=>'double', 'label'=>'PMPReal', 'visible'=>1, 'enabled'=>1, 'position'=>35),
    'pmp_expected' => array('type'=>'double', 'label'=>'PMPExpected', 'visible'=>1, 'enabled'=>1, 'position'=>36),
  );

  public $rowid;

  public $fk_inventory;
  public $fk_warehouse;
  public $fk_product;
  public $batch;
  public $datec;
  public $tms;
  public $qty_stock;
  public $qty_view;
  public $qty_regulated;
  public $pmp_real;
  public $pmp_expected;


  public function create(User $user, $notrigger = false)
  {
    return $this->createCommon($user, $notrigger);
  }

  public function fetch($id, $ref = null)
  {
    $result = $this->fetchCommon($id, $ref);
    //if ($result > 0 && ! empty($this->table_element_line)) $this->fetchLines();
    return $result;
  }

  public function update(User $user, $notrigger = false)
  {
    return $this->updateCommon($user, $notrigger);
  }

  public function delete(User $user, $notrigger = false)
  {
    return $this->deleteCommon($user, $notrigger);
    //return $this->deleteCommon($user, $notrigger, 1);
  }
}