ProductAttribute.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2016     Marcos García   <marcosgdf@gmail.com>
 * Copyright (C) 2022       Open-Dsi      <support@open-dsi.fr>
 * Copyright (C) 2023-2024  Frédéric France     <frederic.france@free.fr>
 * Copyright (C) 2024   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/>.
 */
 
require_once DOL_DOCUMENT_ROOT.'/core/class/commonobject.class.php';
 
class ProductAttribute extends CommonObject
{
  public $db;
 
  public $module = 'variants';
 
  public $element = 'productattribute';
 
  public $table_element = 'product_attribute';
 
  public $table_element_line = 'product_attribute_value';
 
  public $fk_element = 'fk_product_attribute';
 
  public $picto = 'product';
 
  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"),
    'ref' => array('type' => 'varchar(255)', 'label' => 'Ref', 'visible' => 1, 'enabled' => 1, 'position' => 10, 'notnull' => 1, 'index' => 1, 'searchall' => 1, 'comment' => "Reference of object", 'css' => 'width200'),
    'ref_ext' => array('type' => 'varchar(255)', 'label' => 'ExternalRef', 'enabled' => 1, 'visible' => 0, 'position' => 20, 'searchall' => 1),
    'label' => array('type' => 'varchar(255)', 'label' => 'Label', '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' => 40, 'notnull' => 1,),
  );
 
  public $id;
 
  public $ref;
 
  public $ref_ext;
 
  public $label;
 
  public $rang;
 
  public $position;
 
  public $lines = array();
 
  public $line;
 
  public $is_used_by_products;
 
 
  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->ref = strtoupper(dol_sanitizeFileName(dol_string_nospecial(trim($this->ref)))); // Ref must be uppercase
    $this->label = trim($this->label);
    $this->position = $this->position > 0 ? $this->position : 0;
 
    // Position to use
    if (empty($this->position)) {
      $positionmax = $this->getMaxAttributesPosition();
      $this->position = $positionmax + 1;
    }
 
    // Check parameters
    if (empty($this->ref)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Ref"));
      $error++;
    }
    if (empty($this->label)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Label"));
      $error++;
    }
    if ($error) {
      dol_syslog(__METHOD__ . ' ' . $this->errorsToString(), LOG_ERR);
      return -1;
    }
 
    $this->db->begin();
 
    $sql = "INSERT INTO " . MAIN_DB_PREFIX . $this->table_element . " (";
    $sql .= " ref, ref_ext, label, entity, position";
    $sql .= ")";
    $sql .= " VALUES (";
    $sql .= "  '" . $this->db->escape($this->ref) . "'";
    $sql .= ", '" . $this->db->escape($this->ref_ext) . "'";
    $sql .= ", '" . $this->db->escape($this->label) . "'";
    $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_CREATE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      $this->db->commit();
      return $this->id;
    } else {
      $this->db->rollback();
      return -1 * $error;
    }
  }
 
  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, ref, ref_ext, label, position";
    $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->ref = $obj->ref;
      $this->ref_ext = $obj->ref_ext;
      $this->label = $obj->label;
      $this->rang = $obj->position; // deprecated
      $this->position = $obj->position;
      $this->fetch_optionals();
    }
    $this->db->free($resql);
 
    return $numrows;
  }
 
  public function fetchAll()
  {
    $return = array();
 
    $sql = "SELECT rowid, ref, ref_ext, label, position";
    $sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE entity IN (" . getEntity('product') . ")";
    $sql .= $this->db->order("position", "asc");
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if (!$resql) {
      $this->errors[] = "Error " . $this->db->lasterror();
      dol_print_error($this->db);
      return $return;
    }
 
    while ($obj = $this->db->fetch_object($resql)) {
      $tmp = new ProductAttribute($this->db);
 
      $tmp->id = $obj->rowid;
      $tmp->ref = $obj->ref;
      $tmp->ref_ext = $obj->ref_ext;
      $tmp->label = $obj->label;
      $tmp->rang = $obj->position; // deprecated
      $tmp->position = $obj->position;
 
      $return[] = $tmp;
    }
 
    return $return;
  }
 
  public function update(User $user, $notrigger = 0)
  {
    global $langs;
    $error = 0;
 
    // Clean parameters
    $this->id = $this->id > 0 ? $this->id : 0;
    $this->ref = strtoupper(dol_sanitizeFileName(dol_string_nospecial(trim($this->ref)))); // Ref must be uppercase
    $this->label = trim($this->label);
 
    // Check parameters
    if (empty($this->id)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("TechnicalID"));
      $error++;
    }
    if (empty($this->ref)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Ref"));
      $error++;
    }
    if (empty($this->label)) {
      $this->errors[] = $langs->trans("ErrorFieldRequired", $langs->transnoentitiesnoconv("Label"));
      $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 .= "  ref = '" . $this->db->escape($this->ref) . "'";
    $sql .= ", ref_ext = '" . $this->db->escape($this->ref_ext) . "'";
    $sql .= ", label = '" . $this->db->escape($this->label) . "'";
    $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) {
      $result = $this->insertExtraFields();
      if ($result < 0) {
        $error++;
      }
    }
    if (!$error && !$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PRODUCT_ATTRIBUTE_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('ErrorAttributeIsUsedIntoProduct');
      return -1;
    }
 
    $this->db->begin();
 
    if (!$notrigger) {
      // Call trigger
      $result = $this->call_trigger('PRODUCT_ATTRIBUTE_DELETE', $user);
      if ($result < 0) {
        $error++;
      }
      // End call triggers
    }
 
    if (!$error) {
      // Delete values
      $sql = "DELETE FROM " . MAIN_DB_PREFIX . $this->table_element_line;
      $sql .= " WHERE " . $this->fk_element . " = " . ((int) $this->id);
 
      dol_syslog(__METHOD__ . ' - Delete values', LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) {
        $this->errors[] = "Error " . $this->db->lasterror();
        $error++;
      }
    }
 
    if (!$error) {
      $sql = "DELETE FROM " . MAIN_DB_PREFIX . $this->table_element;
      $sql .= " WHERE rowid = " . ((int) $this->id);
 
      dol_syslog(__METHOD__ . ' - Delete attribute', LOG_DEBUG);
      $resql = $this->db->query($sql);
      if (!$resql) {
        $this->errors[] = "Error " . $this->db->lasterror();
        $error++;
      }
    }
 
    if (!$error) {
      $this->db->commit();
      return 1;
    } else {
      $this->db->rollback();
      return -1 * $error;
    }
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function fetch_lines($filters = '')
  {
    // phpcs:enable
    global $langs;
 
    $this->lines = array();
 
    $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 td.rowid, td.fk_product_attribute, td.ref, td.value, td.position";
    $sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element_line . " AS td";
    $sql .= " LEFT JOIN " . MAIN_DB_PREFIX . $this->table_element . " AS t ON t.rowid = td." . $this->fk_element;
    $sql .= " WHERE t.rowid = " . ((int) $this->id);
    $sql .= " AND t.entity IN (" . getEntity('product') . ")";
    if ($filters) {
      $sql .= $filters;
    }
    $sql .= $this->db->order("td.position", "asc");
 
    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 -3;
    }
 
    $num = $this->db->num_rows($resql);
    if ($num) {
      $i = 0;
      while ($i < $num) {
        $obj = $this->db->fetch_object($resql);
 
        $line = new ProductAttributeValue($this->db);
 
        $line->id = $obj->rowid;
        $line->fk_product_attribute = $obj->fk_product_attribute;
        $line->ref = $obj->ref;
        $line->value = $obj->value;
        $line->position = $obj->position;
        $line->fetch_optionals();
 
        $this->lines[$i] = $line;
        $i++;
      }
    }
    $this->db->free($resql);
 
    return $num;
  }
 
  public function getLinesArray($filters = '')
  {
    return $this->fetch_lines($filters);
  }
 
  public function addLine($ref, $value, $position = -1, $notrigger = 0)
  {
    global $langs, $user;
    dol_syslog(__METHOD__ . " id=".$this->id.", ref=".$ref.", value=".$value.", notrigger=".$notrigger);
    $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;
    }
 
    $this->db->begin();
 
    // Fetch current line from the database and then clone the object and set it in $oldcopy property
    $this->line = new ProductAttributeValue($this->db);
 
    // Position to use
    $positiontouse = $position;
    if ($positiontouse == -1) {
      $positionmax = $this->line_max(0);
      $positiontouse = $positionmax + 1;
    }
 
    $this->line->context = $this->context;
    $this->line->fk_product_attribute = $this->id;
    $this->line->ref = $ref;
    $this->line->value = $value;
    $this->line->position = $positiontouse;
 
    $result = $this->line->create($user, $notrigger);
 
    if ($result < 0) {
      $this->error = $this->line->error;
      $this->errors = $this->line->errors;
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $this->line->id;
    }
  }
 
 
  public function updateLine($lineid, $ref, $value, $notrigger = 0)
  {
    global $user;
 
    dol_syslog(__METHOD__ . " lineid=$lineid, ref=$ref, value=$value, notrigger=$notrigger");
 
    // Clean parameters
    $lineid = $lineid > 0 ? $lineid : 0;
 
    $this->db->begin();
 
    // Fetch current line from the database and then clone the object and set it in $oldcopy property
    $this->line = new ProductAttributeValue($this->db);
    $result = $this->line->fetch($lineid);
    if ($result > 0) {
      $this->line->oldcopy = clone $this->line;
 
      $this->line->context = $this->context;
      $this->line->ref = $ref;
      $this->line->value = $value;
 
      $result = $this->line->update($user, $notrigger);
    }
 
    if ($result < 0) {
      $this->error = $this->line->error;
      $this->errors = $this->line->errors;
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $result;
    }
  }
 
  public function deleteLine(User $user, $lineid, $notrigger = 0)
  {
    dol_syslog(__METHOD__ . " lineid=$lineid, notrigger=$notrigger");
 
    // Clean parameters
    $lineid = $lineid > 0 ? $lineid : 0;
 
    $this->db->begin();
 
    // Fetch current line from the database
    $this->line = new ProductAttributeValue($this->db);
    $result = $this->line->fetch($lineid);
    if ($result > 0) {
      $this->line->context = $this->context;
 
      $result = $this->line->delete($user, $notrigger);
    }
 
    if ($result < 0) {
      $this->error = $this->line->error;
      $this->errors = $this->line->errors;
      $this->db->rollback();
      return -1;
    } else {
      $this->db->commit();
      return $result;
    }
  }
 
  public function countChildValues()
  {
    global $langs;
    $error = 0;
    $count = 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 count";
    $sql .= " FROM " . MAIN_DB_PREFIX . $this->table_element_line;
    $sql .= " WHERE " . $this->fk_element . " = " . ((int) $this->id);
 
    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;
    }
 
    if ($obj = $this->db->fetch_object($resql)) {
      $count = $obj->count;
    }
 
    return $count;
  }
 
  public function countChildProducts()
  {
    global $langs;
    $error = 0;
    $count = 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 count";
    $sql .= " FROM " . MAIN_DB_PREFIX . "product_attribute_combination2val AS pac2v";
    $sql .= " LEFT JOIN " . MAIN_DB_PREFIX . "product_attribute_combination AS pac ON pac2v.fk_prod_combination = pac.rowid";
    $sql .= " WHERE pac2v.fk_prod_attr = " . ((int) $this->id);
    $sql .= " AND pac.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;
    }
 
    if ($obj = $this->db->fetch_object($resql)) {
      $count = $obj->count;
    }
 
    return $count;
  }
 
  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 = " . ((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;
  }
 
  public function attributeOrder($renum = false, $rowidorder = 'ASC')
  {
    // Count number of attributes to reorder (according to choice $renum)
    $nl = 0;
    $sql = "SELECT count(rowid) FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE entity IN (" . getEntity('product') . ")";
    if (!$renum) {
      $sql .= " AND position = 0";
    } else {
      $sql .= " AND position <> 0";
    }
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    $resql = $this->db->query($sql);
    if ($resql) {
      $row = $this->db->fetch_row($resql);
      $nl = $row[0];
    } else {
      dol_print_error($this->db);
    }
    if ($nl > 0) {
      // The goal of this part is to reorder all attributes.
      $rows = array();
 
      // We first search all attributes
      $sql = "SELECT rowid FROM " . MAIN_DB_PREFIX . $this->table_element;
      $sql .= " WHERE entity IN (" . getEntity('product') . ")";
      $sql .= " ORDER BY position ASC, rowid " . $rowidorder;
 
      dol_syslog(__METHOD__ . " search all attributes", LOG_DEBUG);
      $resql = $this->db->query($sql);
      if ($resql) {
        $i = 0;
        $num = $this->db->num_rows($resql);
        while ($i < $num) {
          $row = $this->db->fetch_row($resql);
          $rows[] = $row[0]; // Add attributes into array rows
          $i++;
        }
 
        // Now we set a new number for each attributes
        if (!empty($rows)) {
          foreach ($rows as $key => $row) {
            $this->updatePositionOfAttribute($row, ($key + 1));
          }
        }
      } else {
        dol_print_error($this->db);
      }
    }
    return 1;
  }
 
  public function updatePositionOfAttribute($rowid, $position)
  {
    global $hookmanager;
 
    $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET position = " . ((int) $position);
    $sql .= " WHERE rowid = " . ((int) $rowid);
 
    dol_syslog(__METHOD__, LOG_DEBUG);
    if (!$this->db->query($sql)) {
      dol_print_error($this->db);
      return -1;
    } else {
      $parameters = array('rowid' => $rowid, 'position' => $position);
      $action = '';
      $reshook = $hookmanager->executeHooks('afterPositionOfAttributeUpdate', $parameters, $this, $action);
      return ($reshook >= 0 ? 1 : -1);
    }
  }
 
  public function getPositionOfAttribute($rowid)
  {
    $sql = "SELECT position FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE entity IN (" . getEntity('product') . ")";
 
    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 attributeMoveUp($rowid)
  {
    $this->attributeOrder(false, 'ASC');
 
    // Get position of attribute
    $position = $this->getPositionOfAttribute($rowid);
 
    // Update position of attribute
    $this->updateAttributePositionUp($rowid, $position);
 
    return 1;
  }
 
  public function attributeMoveDown($rowid)
  {
    $this->attributeOrder(false, 'ASC');
 
    // Get position of line
    $position = $this->getPositionOfAttribute($rowid);
 
    // Get max value for position
    $max = $this->getMaxAttributesPosition();
 
    // Update position of attribute
    $this->updateAttributePositionDown($rowid, $position, $max);
 
    return 1;
  }
 
  public function updateAttributePositionUp($rowid, $position)
  {
    if ($position > 1) {
      $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET position = " . ((int) $position);
      $sql .= " WHERE entity IN (" . getEntity('product') . ")";
      $sql .= " AND position = " . ((int) ($position - 1));
      if ($this->db->query($sql)) {
        $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET position = " . ((int) ($position - 1));
        $sql .= " WHERE rowid = " . ((int) $rowid);
        if (!$this->db->query($sql)) {
          dol_print_error($this->db);
        }
      } else {
        dol_print_error($this->db);
      }
    }
  }
 
  public function updateAttributePositionDown($rowid, $position, $max)
  {
    if ($position < $max) {
      $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET position = " . ((int) $position);
      $sql .= " WHERE entity IN (" . getEntity('product') . ")";
      $sql .= " AND position = " . ((int) ($position + 1));
      if ($this->db->query($sql)) {
        $sql = "UPDATE " . MAIN_DB_PREFIX . $this->table_element . " SET position = " . ((int) ($position + 1));
        $sql .= " WHERE rowid = " . ((int) $rowid);
        if (!$this->db->query($sql)) {
          dol_print_error($this->db);
        }
      } else {
        dol_print_error($this->db);
      }
    }
  }
 
  public function getMaxAttributesPosition()
  {
    // Search the last position of attributes
    $sql = "SELECT max(position) FROM " . MAIN_DB_PREFIX . $this->table_element;
    $sql .= " WHERE entity IN (" . getEntity('product') . ")";
 
    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 attributesAjaxOrder($rows)
  {
    $num = count($rows);
    for ($i = 0; $i < $num; $i++) {
      $this->updatePositionOfAttribute($rows[$i], ($i + 1));
    }
  }
 
  public function getNomUrl($withpicto = 0, $option = '', $notooltip = 0, $morecss = '', $save_lastsearch_value = -1)
  {
    global $conf, $langs, $hookmanager;
 
    if (!empty($conf->dol_no_mouse_hover)) {
      $notooltip = 1; // Force disable tooltips
    }
 
    $result = '';
 
    $label = img_picto('', $this->picto) . ' <u>' . $langs->trans("ProductAttribute") . '</u>';
    if (isset($this->status)) {
      $label .= ' ' . $this->getLibStatut(5);
    }
    $label .= '<br>';
    $label .= '<b>' . $langs->trans('Ref') . ':</b> ' . $this->ref;
    if (!empty($this->label)) {
      $label .= '<br><b>' . $langs->trans('Label') . ':</b> ' . $this->label;
    }
 
    $url = dol_buildpath('/variants/card.php', 1) . '?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 ($url && $add_save_lastsearch_values) {
        $url .= '&save_lastsearch_values=1';
      }
    }
 
    $linkclose = '';
    if (empty($notooltip)) {
      if (getDolGlobalString('MAIN_OPTIMIZEFORTEXTBROWSER')) {
        $label = $langs->trans("ShowProductAttribute");
        $linkclose .= ' alt="' . dol_escape_htmltag($label, 1) . '"';
      }
      $linkclose .= ' title="' . dol_escape_htmltag($label, 1) . '"';
      $linkclose .= ' class="classfortooltip' . ($morecss ? ' ' . $morecss : '') . '"';
    } else {
      $linkclose = ($morecss ? ' class="' . $morecss . '"' : '');
    }
 
    if ($option == 'nolink' || empty($url)) {
      $linkstart = '<span';
    } else {
      $linkstart = '<a href="' . $url . '"';
    }
    $linkstart .= $linkclose . '>';
    if ($option == 'nolink' || empty($url)) {
      $linkend = '</span>';
    } else {
      $linkend = '</a>';
    }
 
    $result .= $linkstart;
 
    if (empty($this->showphoto_on_popup)) {
      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);
      }
    } else {
      if ($withpicto) {
        require_once DOL_DOCUMENT_ROOT . '/core/lib/files.lib.php';
 
        list($class, $module) = explode('@', $this->picto);
        $upload_dir = $conf->$module->multidir_output[$conf->entity] . "/$class/" . dol_sanitizeFileName($this->ref);
        $filearray = dol_dir_list($upload_dir, "files");
        $filename = $filearray[0]['name'];
        if (!empty($filename)) {
          $pospoint = strpos($filearray[0]['name'], '.');
 
          $pathtophoto = $class . '/' . $this->ref . '/thumbs/' . substr($filename, 0, $pospoint) . '_mini' . substr($filename, $pospoint);
          if (!getDolGlobalString(strtoupper($module . '_' . $class) . '_FORMATLISTPHOTOSASUSERS')) {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><div class="photoref"><img class="photo' . $module . '" alt="No photo" border="0" src="' . DOL_URL_ROOT . '/viewimage.php?modulepart=' . $module . '&entity=' . $conf->entity . '&file=' . urlencode($pathtophoto) . '"></div></div>';
          } else {
            $result .= '<div class="floatleft inline-block valignmiddle divphotoref"><img class="photouserphoto userphoto" alt="No photo" border="0" src="' . DOL_URL_ROOT . '/viewimage.php?modulepart=' . $module . '&entity=' . $conf->entity . '&file=' . urlencode($pathtophoto) . '"></div>';
          }
 
          $result .= '</div>';
        } else {
          $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(array('variantsdao'));
    $parameters = array('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;
  }
 
  public function getKanbanView($option = '', $arraydata = null)
  {
    $selected = (empty($arraydata['selected']) ? 0 : $arraydata['selected']);
 
    $return = '<div class="box-flex-item box-flex-grow-zero">';
    $return .= '<div class="info-box info-box-sm">';
    $return .= '<span class="info-box-icon bg-infobox-action">';
    $return .= img_picto('', $this->picto);
    $return .= '</span>';
    $return .= '<div class="info-box-content">';
    $return .= '<span class="info-box-ref inline-block tdoverflowmax150 valignmiddle">'.(method_exists($this, 'getNomUrl') ? $this->getNomUrl() : $this->ref).'</span>';
    if ($selected >= 0) {
      $return .= '<input id="cb'.$this->id.'" class="flat checkforselect fright" type="checkbox" name="toselect[]" value="'.$this->id.'"'.($selected ? ' checked="checked"' : '').'>';
    }
    if (property_exists($this, 'label')) {
      $return .= ' <div class="inline-block opacitymedium valignmiddle tdoverflowmax100">'.$this->label.'</div>';
    }
    if (property_exists($this, 'thirdparty') && is_object($this->thirdparty)) {
      $return .= '<br><div class="info-box-ref tdoverflowmax150">'.$this->thirdparty->getNomUrl(1).'</div>';
    }
    if (method_exists($this, 'getLibStatut')) {
      $return .= '<br><div class="info-box-status">'.$this->getLibStatut(3).'</div>';
    }
    $return .= '</div>';
    $return .= '</div>';
    $return .= '</div>';
 
    return $return;
  }
 
  public function getLabelStatus($mode = 0)
  {
    return $this->LibStatut(0, $mode);
  }
 
  public function getLibStatut($mode = 0)
  {
    return $this->LibStatut(0, $mode);
  }
 
  // phpcs:disable PEAR.NamingConventions.ValidFunctionName.ScopeNotCamelCaps
  public function LibStatut($status, $mode = 1)
  {
    // phpcs:enable
    return '';
  }
 
  // --------------------
  // TODO: All functions here must be redesigned and moved as they are not business functions but output functions
  // --------------------
 
  /* This is to show add lines */
 
  public function formAddObjectLine($dateSelector, $seller, $buyer, $defaulttpldir = '/variants/tpl')
  {
    global $conf, $user, $langs, $object, $hookmanager;
    global $form;
 
    // Output template part (modules that overwrite templates must declare this into descriptor)
    // Use global variables + $dateSelector + $seller and $buyer
    // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook 'formAddObjectLine'.
    $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
    foreach ($dirtpls as $module => $reldir) {
      if (!empty($module)) {
        $tpl = dol_buildpath($reldir . '/productattributevalueline_create.tpl.php');
      } else {
        $tpl = DOL_DOCUMENT_ROOT . $reldir . '/productattributevalueline_create.tpl.php';
      }
 
      if (empty($conf->file->strict_mode)) {
        $res = @include $tpl;
      } else {
        $res = include $tpl; // for debug
      }
      if ($res) {
        break;
      }
    }
  }
 
  /* This is to show array of line of details */
 
  public function printObjectLines($action, $seller, $buyer, $selected = 0, $dateSelector = 0, $defaulttpldir = '/variants/tpl', $addcreateline = 0)
  {
    global $conf, $hookmanager, $langs, $user, $form, $object;
    global $mysoc;
    // TODO We should not use global var for this
    global $disableedit, $disablemove, $disableremove;
 
    $num = count($this->lines);
 
    $parameters = array('num' => $num, 'selected' => $selected, 'table_element_line' => $this->table_element_line);
    $reshook = $hookmanager->executeHooks('printObjectLineTitle', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
    if (empty($reshook)) {
      // Output template part (modules that overwrite templates must declare this into descriptor)
      // Use global variables + $dateSelector + $seller and $buyer
      // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook.
      $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
      foreach ($dirtpls as $module => $reldir) {
        if (!empty($module)) {
          $tpl = dol_buildpath($reldir . '/productattributevalueline_title.tpl.php');
        } else {
          $tpl = DOL_DOCUMENT_ROOT . $reldir . '/productattributevalueline_title.tpl.php';
        }
        if (empty($conf->file->strict_mode)) {
          $res = @include $tpl;
        } else {
          $res = include $tpl; // for debug
        }
        if ($res) {
          break;
        }
      }
    }
 
 
    if ($addcreateline) {
      // Form to add new line
      if ($action != 'selectlines') {
        if ($action != 'editline') {
          // Add products/services form
 
          $parameters = array();
          $reshook = $hookmanager->executeHooks('formAddObjectLine', $parameters, $object, $action); // Note that $action and $object may have been modified by hook
          if ($reshook < 0) {
            setEventMessages($hookmanager->error, $hookmanager->errors, 'errors');
          }
          if (empty($reshook)) {
            $object->formAddObjectLine(1, $mysoc, $buyer);
          }
        }
      }
    }
 
    $i = 0;
 
    print "<!-- begin printObjectLines() -->\n";
    foreach ($this->lines as $line) {
      if (is_object($hookmanager)) {   // Old code is commented on preceding line.
        $parameters = array('line' => $line, 'num' => $num, 'i' => $i, 'selected' => $selected, 'table_element_line' => $line->table_element);
        $reshook = $hookmanager->executeHooks('printObjectLine', $parameters, $this, $action); // Note that $action and $object may have been modified by some hooks
      }
      if (empty($reshook)) {
        $this->printObjectLine($action, $line, '', $num, $i, $dateSelector, $seller, $buyer, $selected, null, $defaulttpldir);
      }
 
      $i++;
    }
    print "<!-- end printObjectLines() -->\n";
  }
 
  public function printObjectLine($action, $line, $var, $num, $i, $dateSelector, $seller, $buyer, $selected = 0, $extrafields = null, $defaulttpldir = '/variants/tpl')
  {
    global $conf, $langs, $user, $object, $hookmanager;
    global $form;
    global $disableedit, $disablemove, $disableremove; // TODO We should not use global var for this !
 
    // Line in view mode
    if ($action != 'editline' || $selected != $line->id) {
      // Output template part (modules that overwrite templates must declare this into descriptor)
      // Use global variables + $dateSelector + $seller and $buyer
      // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
      $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
      foreach ($dirtpls as $module => $reldir) {
        if (!empty($module)) {
          $tpl = dol_buildpath($reldir . '/productattributevalueline_view.tpl.php');
        } else {
          $tpl = DOL_DOCUMENT_ROOT . $reldir . '/productattributevalueline_view.tpl.php';
        }
 
        if (empty($conf->file->strict_mode)) {
          $res = @include $tpl;
        } else {
          $res = include $tpl; // for debug
        }
        if ($res) {
          break;
        }
      }
    }
 
    // Line in update mode
    if ($action == 'editline' && $selected == $line->id) {
      // Output template part (modules that overwrite templates must declare this into descriptor)
      // Use global variables + $dateSelector + $seller and $buyer
      // Note: This is deprecated. If you need to overwrite the tpl file, use instead the hook printObjectLine and printObjectSubLine.
      $dirtpls = array_merge($conf->modules_parts['tpl'], array($defaulttpldir));
      foreach ($dirtpls as $module => $reldir) {
        if (!empty($module)) {
          $tpl = dol_buildpath($reldir . '/productattributevalueline_edit.tpl.php');
        } else {
          $tpl = DOL_DOCUMENT_ROOT . $reldir . '/productattributevalueline_edit.tpl.php';
        }
 
        if (empty($conf->file->strict_mode)) {
          $res = @include $tpl;
        } else {
          $res = include $tpl; // for debug
        }
        if ($res) {
          break;
        }
      }
    }
  }
 
  /* This is to show array of line of details of source object */
}