checkboxfield.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/commonselectfield.class.php';
 
 
class CheckboxField extends CommonSelectField
{
  public $emptyValues = array(array(), '');
 
 
  public function printInputSearchField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    return $this->printInputField($fieldInfos, $key, $value, $keyPrefix, $keySuffix, $moreCss, $moreAttrib);
  }
 
  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;
    }
    $htmlName = $keyPrefix . $key . $keySuffix;
    $values = $this->isEmptyValue($fieldInfos, $value) ? array() : (is_string($value) ? explode(',', $value) : (is_array($value) ? $value : array($value)));
 
    $optionsList = array();
    $options = $this->getOptions($fieldInfos, $key);
 
    return self::$form->multiselectarray($htmlName, $options, $values, 0, 0, $moreCss, 0, 0, $moreAttrib, '', '', (int) (!empty($conf->use_javascript_ajax) && !getDolGlobalString('MAIN_EXTRAFIELDS_DISABLE_SELECT2')));
  }
 
  public function printOutputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    global $langs;
    $values = $this->isEmptyValue($fieldInfos, $value) ? array() : (is_string($value) ? explode(',', $value) : (is_array($value) ? $value : array($value)));
 
    $out = '';
    if (!$this->isEmptyValue($fieldInfos, $values)) {
      $options = $this->getOptions($fieldInfos, $key);
      $toPrint = array();
      foreach ($values as $val) {
        $valueToPrint = null;
        foreach ($options as $optionKey => $optionInfos) {
          if (((string) $optionKey) == $val) {
            $valueToPrint = $optionInfos['label'];
            break;
          }
        }
        if (!isset($valueToPrint)) {
          $langs->load("errors");
          $valueToPrint = $langs->trans('ErrorRecordNotFound') . ' ( ' . $val . ' )';
        }
        $toPrint[] = $valueToPrint;
      }
      $out = self::$form->outputMultiValues($toPrint);
    }
 
    return $out;
  }
 
  public function getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')
  {
    return parent::getInputCss($fieldInfos, $moreCss, $defaultCss ? $defaultCss : 'minwidth400');
  }
 
  public function verifyFieldValue($fieldInfos, $key, $value)
  {
    global $langs;
    $values = $this->isEmptyValue($fieldInfos, $value) ? array() : (is_string($value) ? explode(',', $value) : (is_array($value) ? $value : array($value)));
 
    $result = parent::verifyFieldValue($fieldInfos, $key, $values);
    if ($result && !$this->isEmptyValue($fieldInfos, $values)) {
      $options = $this->getOptions($fieldInfos, $key);
      foreach ($values as $val) {
        $newVal = trim((string) $val);
        if (!isset($options[$newVal])) {
          self::$validator->error = $langs->trans('RequireValidValue');
          return false;
        }
      }
 
      $result = true;
    }
 
    return $result;
  }
 
  public function verifyPostFieldValue($fieldInfos, $key, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
    $values = GETPOST($htmlName, 'array');
 
    return $this->verifyFieldValue($fieldInfos, $key, $values);
  }
 
  public function getPostFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $values = GETPOST($htmlName, 'array');
      if (is_array($values)) {
        $values = implode(',', $values);
      }
    } else {
      $values = $defaultValue;
    }
 
    return $values;
  }
 
  public function getPostSearchFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $values = GETPOST($htmlName, 'array');
    } else {
      $values = $defaultValue;
    }
 
    return $values;
  }
 
  public function sqlFilterSearchField($fieldInfos, $key, $value)
  {
    if (!$this->isEmptyValue($fieldInfos, $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)
  {
    return parent::getOptions($fieldInfos, $key, $addEmptyValue, $reload);
  }
}