ProductAttributeValue.class.php

<?php
/* Copyright (C) 2016   Marcos García     <marcosgdf@gmail.com>
 * Copyright (C) 2022     Open-Dsi        <support@open-dsi.fr>
 * Copyright (C) 2024   MDW           <mdeweerd@users.noreply.github.com>
 * Copyright (C) 2024       Frédéric France         <frederic.france@free.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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobjectline.class.php';
class ProductAttributeValue extends CommonObjectLine
{
  public $module = 'variants';
 
  public $element = 'productattributevalue';
 
  public $table_element = 'product_attribute_value';
 
  public $fields = array(
    'rowid' => array('type' => 'integer', 'label' => 'TechnicalID', 'enabled' => 1, 'position' => 1, 'notnull' => 1, 'visible' => 0, 'noteditable' => 1, 'index' => 1, 'css' => 'left', 'comment' => "Id"),
    'fk_product_attribute' => array('type' => 'integer:ProductAttribute:variants/class/ProductAttribute.class.php', 'label' => 'ProductAttribute', 'enabled' => 1, 'visible' => 0, 'position' => 10, 'notnull' => 1, 'index' => 1,),
    'ref' => array('type' => 'varchar(255)', 'label' => 'Ref', 'visible' => 1, 'enabled' => 1, 'position' => 20, 'notnull' => 1, 'index' => 1, 'searchall' => 1, 'comment' => "Reference of object", 'css' => ''),
    'value' => array('type' => 'varchar(255)', 'label' => 'Value', 'enabled' => 1, 'position' => 30, 'notnull' => 1, 'visible' => 1, 'searchall' => 1, 'css' => 'minwidth300', 'help' => "", 'showoncombobox' => 1,),
    'position' => array('type' => 'integer', 'label' => 'Rank', 'enabled' => 1, 'visible' => 0, 'default' => '0', 'position' => 200, 'notnull' => 1,),
  );
 
  public $id;
 
  public $fk_product_attribute;
 
  public $ref;
 
  public $value;
 
  public $position;
 
  public function __construct(DoliDB $db)
  {
    global $conf, $langs;
 
    $this->db = $db;
 
    $this->ismultientitymanaged = 1;
    $this->isextrafieldmanaged = 1;
    $this->entity = $conf->entity;
 
    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
    if (is_object($langs)) {
      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);
          }
        }
      }
    }
  }
 
  public function create(User $user, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $this->fk_product_attribute = $this->fk_product_attribute > 0 ? $this->fk_product_attribute : 0;
    $this->ref = strtoupper(dol_sanitizeFileName(dol_string_nospecial(trim($this->ref)))); // Ref must be uppercase
    $this->value = trim($this->value);
 
    // Check parameters
    if (empty($this->fk_product_attribute)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("ProductAttribute"));
      $error++;
    }
    if (empty($this->ref)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Ref"));
      $error++;
    }
    if (empty($this->value)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Value"));
      $error++;
    }
    // Position to use
    if (empty($this->position)) {
      $positionmax = $this->getMaxAttributesValuesPosition($this->fk_product_attribute);
      $this->position = $positionmax + 1;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $this->db->begin();
 
    $sql = "INSERT INTO " . MAIN_DB_PREFIX . $this->table_element . " (";
    $sql .= " fk_product_attribute, ref, value, entity, position";
    $sql .= ")";
    $sql .= " VALUES (";
    $sql .= "  " . ((int) $this->fk_product_attribute);
    $sql .= ", '" . $this->db->escape($this->ref) . "'";
    $sql .= ", '" . $this->db->escape($this->value) . "'";
    $sql .= ", " . ((int) $this->entity);
    $sql .= ", " . ((int) $this->position);
    $sql .= ")";
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = "Error " . $this->db->lasterror();
      $error++;
    }
 
    if (!$error) {
      $this->id = $this->db->last_insert_id(MAIN_DB_PREFIX . $this->table_element);
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PRODUCT_ATTRIBUTE_VALUE_CREATE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if ($error) {
      $this->db->rollback();
      return -1 * $error;
    } else {
      $this->db->commit();
      return $this->id;
    }
  }
 
  public function fetch($id)
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $id = $id > 0 ? $id : 0;
 
    // Check parameters
    if (empty($id)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("TechnicalID"));
      $error++;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $sql = "SELECT rowid, fk_product_attribute, ref, value";
    $sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE rowid = " . ((int) $id);
    $sql .= " AND entity IN (" . getEntity('product') . ")";
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = "Error " . $this->db->lasterror();
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $numrows = $this->db->num_rows($resql);
    if ($numrows) {
      $obj = $this->db->fetch_object($resql);
 
      $this->id = $obj->rowid;
      $this->fk_product_attribute = $obj->fk_product_attribute;
      $this->ref = $obj->ref;
      $this->value = $obj->value;
      $this->fetch_optionals();
    }
    $this->db->free($resql);
 
    return $numrows;
  }
 
  public function fetchAllByProductAttribute($prodattr_id, $only_used = false, $returnonlydata = 0)
  {
    $return = array();
 
    $sql = "SELECT v.fk_product_attribute, v.rowid, v.ref, v.value FROM " . MAIN_DB_PREFIX . "product_attribute_value v ";
 
    $sql .= "WHERE v.fk_product_attribute = " . ((int) $prodattr_id);
 
    if ($only_used) {
      $sql .= " AND EXISTS (SELECT c2v.fk_prod_attr_val ";
      $sql .= "FROM " . MAIN_DB_PREFIX . "product_attribute_combination2val c2v ";
      $sql .= "LEFT JOIN " . MAIN_DB_PREFIX . "product_attribute_combination c ON c.rowid = c2v.fk_prod_combination ";
      $sql .= "LEFT JOIN " . MAIN_DB_PREFIX . "product p ON p.rowid = c.fk_product_child";
      $sql .= " WHERE c2v.rowid IS NOT NULL AND p.tosell = 1 AND c2v.fk_prod_attr_val = v.rowid)";
    }
 
    $sql .= " ORDER BY v.position ASC";
 
    $query = $this->db->query($sql);
 
    if ($query) {
      while ($result = $this->db->fetch_object($query)) {
        if (empty($returnonlydata)) {
          $tmp = new ProductAttributeValue($this->db);
        } else {
          $tmp = new stdClass();
        }
 
        $tmp->fk_product_attribute = $result->fk_product_attribute;
        $tmp->id = $result->rowid;
        $tmp->ref = $result->ref;
        $tmp->value = $result->value;
 
        $return[] = $tmp;
      }
    }
 
    return $return;
  }
 
  public function update(User $user, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $this->fk_product_attribute = $this->fk_product_attribute > 0 ? $this->fk_product_attribute : 0;
    $this->ref = strtoupper(dol_sanitizeFileName(dol_string_nospecial(trim($this->ref)))); // Ref must be uppercase
    $this->value = trim($this->value);
 
    // Check parameters
    if (empty($this->fk_product_attribute)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("ProductAttribute"));
      $error++;
    }
    if (empty($this->ref)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Ref"));
      $error++;
    }
    if (empty($this->value)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Value"));
      $error++;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $this->db->begin();
 
    $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET";
 
    $sql .= "  fk_product_attribute = " . ((int) $this->fk_product_attribute);
    $sql .= ", ref = '" . $this->db->escape($this->ref) . "'";
    $sql .= ", value = '" . $this->db->escape($this->value) . "'";
    $sql .= ", position = " . ((int) $this->position);
 
    $sql .= " WHERE rowid = " . ((int) $this->id);
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = "Error " . $this->db->lasterror();
      $error++;
    }
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PRODUCT_ATTRIBUTE_VALUE_MODIFY', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1 * $error;
    }
  }
 
  public function delete(User $user, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $this->id = $this->id > 0 ? $this->id : 0;
 
    // Check parameters
    if (empty($this->id)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("TechnicalID"));
      $error++;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $result = $this->isUsed();
    if ($result < 0) {
      return -1;
    } elseif ($result > 0) {
      $this->errors[] = $langs->trans('ErrorAttributeValueIsUsedIntoProduct');
      return -1;
    }
 
    $this->db->begin();
 
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PRODUCT_ATTRIBUTE_VALUE_DELETE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $sql = "DELETE FROM " . MAIN_DB_PREFIX . $this->table_element . " WHERE rowid = " . ((int) $this->id);
 
      dol_syslog(__METHOD__, LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) {
        $this->errors[] = "Error " . $this->db->lasterror();
        $error++;
      }
    }
    if (!$error) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1 * $error;
    }
  }
 
  public function getMaxAttributesValuesPosition($fk_product_attribute)
  {
    // Search the last position of attributes
    $sql = "SELECT max(position) FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE entity IN (" . getEntity('product') . ")";
    $sql .= ' AND fk_product_attribute='.(int) $fk_product_attribute;
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $row = $this->db->fetch_row($resql);
      return $row[0];
    }
    return 0;
  }
 
  public function isUsed()
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $this->id = $this->id > 0 ? $this->id : 0;
 
    // Check parameters
    if (empty($this->id)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("TechnicalID"));
      $error++;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $sql = "SELECT COUNT(*) AS nb FROM " . MAIN_DB_PREFIX . "product_attribute_combination2val WHERE fk_prod_attr_val = " . ((int) $this->id);
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = "Error " . $this->db->lasterror();
      return -1;
    }
 
    $used = 0;
    if ($obj = $this->db->fetch_object($resql)) {
      $used = $obj->nb;
    }
 
    return $used ? 1 : 0;
  }
}