booleanfield.class.php

Go to the documentation of this file.

<?php
/* Copyright (C) 2025     Open-Dsi         <support@open-dsi.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/fields/commonfield.class.php';
 
 
class BooleanField extends CommonField
{
  public $emptyValues = array('', '-1', -1);
 
 
  public function printInputSearchField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    return self::$form->selectyesno($htmlName, $value, 1, false, 1, 1, 'width75 yesno');
  }
 
  public function printInputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    $moreCss = $this->getInputCss($fieldInfos, $moreCss);
    $moreAttrib = trim((string) $moreAttrib);
    if (empty($moreAttrib)) $moreAttrib = ' ' . $moreAttrib;
    $checked = empty($value) ? '' : ' checked="checked"';
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    $out = self::$form->inputType('checkbox', $htmlName, '1', $htmlName, $moreCss, $moreAttrib . $checked);
    $out .= self::$form->inputType('hidden', $htmlName . '_boolean', '1');    // A hidden field ending with "_boolean" that is always set to 1.
 
    return $out;
  }
 
  public function printOutputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    if (getDolGlobalInt('MAIN_OPTIMIZEFORTEXTBROWSER') < 2) {
      $moreCss = $this->getInputCss($fieldInfos, $moreCss);
      $moreAttrib = trim((string) $moreAttrib);
      if (empty($moreAttrib)) $moreAttrib = ' ' . $moreAttrib;
      $checked = empty($value) ? '' : ' checked="checked"';
      $value = self::$form->inputType('checkbox', '', '1', '', $moreCss, $checked . $moreAttrib . ' readonly disabled');
    } else {
      $value = yn($value ? 1 : 0);
    }
 
    return $value;
  }
 
  public function getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')
  {
    if (empty($moreCss)) $moreCss = $defaultCss;
    $moreCss = trim((string) $moreCss);
 
    return empty($moreCss) ? '' : ' ' . $moreCss;
  }
 
  public function verifyFieldValue($fieldInfos, $key, $value)
  {
    $result = parent::verifyFieldValue($fieldInfos, $key, $value);
    if ($result && !$this->isEmptyValue($fieldInfos, $value)) {
      if (!self::$validator->isBool($value)) {
        return false;
      }
 
      $result = true;
    }
 
    return $result;
  }
 
  public function verifyPostFieldValue($fieldInfos, $key, $keyPrefix = '', $keySuffix = '')
  {
    return parent::verifyPostFieldValue($fieldInfos, $key, $keyPrefix, $keySuffix);
  }
 
  public function getPostFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    // We test on a hidden field named "..._boolean" that is always set to 1 if param is in form so
    // when nothing is provided we can make a difference between noparam in the form and param was set to nothing.
    if (!GETPOSTISSET($htmlName . "_boolean")) {
      $value = $defaultValue;
    } elseif (GETPOSTISSET($htmlName)) {
      $value = GETPOSTINT($htmlName) == 1 ? 1 : 0;
    } else {
      $value = $defaultValue;
    }
 
    return $value;
  }
 
  public function getPostSearchFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $value = GETPOSTINT($htmlName);
    } else {
      $value = $defaultValue;
    }
 
    return $value;
  }
 
  public function sqlFilterSearchField($fieldInfos, $key, $value)
  {
    if (!$this->isEmptyValue($fieldInfos, $value)) {
      $alias = $fieldInfos->sqlAlias ?? 't.';
      $field = $this->db->sanitize($alias . ($fieldInfos->nameInTable ?? $key));
 
      $sql = " AND (" . $field . " = '" . $this->db->escape($value) . "'";
      if ($value == '0') {
        $sql .= " OR " . $field . " IS NULL";
      }
      $sql .= ")";
 
      return $sql;
    }
 
    return '';
  }
}