sellistfield.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2025     Open-Dsi         <support@open-dsi.fr>
 * Copyright (C) 2026   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/fields/commonsellistfield.class.php';
 
 
class SellistField extends CommonSellistField
{
  public $emptyValues = array('', array());
 
 
  public function printInputSearchField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    global $conf;
 
    $moreCss = $this->getInputCss($fieldInfos, $moreCss);
    $moreAttrib = trim((string) $moreAttrib);
    if (empty($moreAttrib)) {
      $moreAttrib = ' ' . $moreAttrib;
    }
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    $optionsList = array();
    $options = $this->getOptions($fieldInfos, $key);
    foreach ($options as $optionKey => $optionInfos) {
      $options[$optionKey] = $optionInfos['label'];
    }
 
    return self::$form->multiselectarray($htmlName, $optionsList, $value, 0, 0, $moreCss, 0, 0, $moreAttrib, '', '', (int) (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')));
  }
 
  public function printInputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    global $conf;
 
    $moreCss = $this->getInputCss($fieldInfos, $moreCss);
    $moreAttrib = trim((string) $moreAttrib);
    if (empty($moreAttrib)) {
      $moreAttrib = ' ' . $moreAttrib;
    }
    $placeHolder = $fieldInfos->inputPlaceholder;
    if (!empty($placeHolder)) {
      $placeHolder = ' placeholder="' . dolPrintHTMLForAttribute($placeHolder) . '"';
    }
    $autoFocus = $fieldInfos->inputAutofocus ? ' autofocus' : '';
    $htmlName = $keyPrefix . $key . $keySuffix;
    $selectedValue = is_null($value) || $this->isEmptyValue($fieldInfos, $value) ? '' : (string) $value;
 
    if (!empty($conf->use_javascript_ajax) && getDolGlobalString('MAIN_EXTRAFIELDS_ENABLE_NEW_SELECT2')) {
      $objectId = isset($fieldInfos->otherParams['objectId']) ? (int) $fieldInfos->otherParams['objectId'] : (isset($fieldInfos->object) && is_object($fieldInfos->object) ? $fieldInfos->object->id : 0);
      $objectType = isset($fieldInfos->otherParams['objectType']) ? (int) $fieldInfos->otherParams['objectType'] : (isset($fieldInfos->object) && is_object($fieldInfos->object) ? $fieldInfos->object->element : '');
      $printMode = empty($fieldInfos->mode) ? 'view' : $fieldInfos->mode;
      $options = $this->getOptions($fieldInfos, $key, false, false, $selectedValue);
 
      // TODO add dependency support (set dependencyvalue with dependency field value get by JS)
      $ajaxData = array(
        'objecttype' => $objectType,
        'objectid' => $objectId,
        'objectkey' => $key,
        'mode' => $printMode,
        'value' => $selectedValue,
        'dependencyvalue' => '',
      );
 
      $out = self::$form->inputSelectAjax($htmlName, $options, $selectedValue, self::$ajaxUrl, $ajaxData, $moreCss, $moreAttrib . $placeHolder . $autoFocus);
    } else {
      $options = $this->getOptions($fieldInfos, $key, true);
 
      $out = self::$form->selectarray($htmlName, $options, $selectedValue, 0, 0, 0, $moreAttrib . $placeHolder . $autoFocus, 0, 0, 0, '', $moreCss);
    }
 
    return $out;
  }
 
  public function printOutputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    $value = (string) $value;
 
    if (!$this->isEmptyValue($fieldInfos, $value)) {
      $options = $this->getOptions($fieldInfos, $key, false, false, $value);
      if (isset($options[$value])) {
        $out = $options[$value]['label'];
 
        $optionParams = $this->getOptionsParams($fieldInfos->options);
        if ($optionParams['tableName'] == 'categorie' && !empty($optionParams['categoryType'])) {
          require_once DOL_DOCUMENT_ROOT . '/categories/class/categorie.class.php';
          $c = new Categorie($this->db);
          $c->fetch((int) $value);
          $color = ' style="background: #' . ($c->color ? $c->color : 'bbb') . ';"';
          $label = img_object('', 'category') . ' ' . $value;
          $out = '<div class="select2-container-multi-dolibarr" style="width: 90%;"><ul class="select2-choices-dolibarr"><li class="select2-search-choice-dolibarr noborderoncategories"' . $color . '>' . $label . '</li></ul></div>';
        }
 
        $value = $out;
      }
    }
 
    return $value;
  }
 
  public function getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')
  {
    return parent::getInputCss($fieldInfos, $moreCss, $defaultCss ? $defaultCss : 'minwidth400');
  }
 
  public function verifyFieldValue($fieldInfos, $key, $value)
  {
    $result = parent::verifyFieldValue($fieldInfos, $key, $value);
    if ($result && !$this->isEmptyValue($fieldInfos, $value)) {
      $optionParams = $this->getOptionsParams($fieldInfos->options);
      if (!self::$validator->isInDb($value, $optionParams['tableName'], $optionParams['keyField'])) {
        return false;
      }
 
      $result = true;
    }
 
    return $result;
  }
 
  public function verifyPostFieldValue($fieldInfos, $key, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
    $value = GETPOST($htmlName, 'restricthtml');
    $value = trim($value);
 
    return $this->verifyFieldValue($fieldInfos, $key, $value);
  }
 
  public function getPostFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $value = GETPOST($htmlName, 'alphanohtml');
    } else {
      $value = $defaultValue;
    }
 
    return $value;
  }
 
  public function getPostSearchFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $value = GETPOST($htmlName, 'array');
    } else {
      $value = $defaultValue;
    }
 
    return $value;
  }
 
  public function sqlFilterSearchField($fieldInfos, $key, $value)
  {
    if (!empty($value) && is_array($value)) {
      $alias = $fieldInfos->sqlAlias ?? 't.';
      $field = $this->db->sanitize($alias . ($fieldInfos->nameInTable ?? $key));
 
      $sanitizedSqlIn = "'" . implode("','", array_map(array($this->db, 'escape'), $value)) . "'";
      $sqlPartialCond = " AND " . $field . " IN (" . $sanitizedSqlIn . ")";
      return $sqlPartialCond;
    }
 
    return '';
  }
 
  public function getOptions($fieldInfos, $key, $addEmptyValue = false, $reload = false, $selectedValues = array())
  {
    return parent::getOptions($fieldInfos, $key, $addEmptyValue, $reload, $selectedValues);
  }
}