commonfield.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/html.form.class.php';
require_once DOL_DOCUMENT_ROOT . '/core/class/validate.class.php';
 
 
abstract class CommonField
{
  public $db;
 
  public $error = '';
 
  public $errors = array();
 
  public $type;
 
  public $label;
 
  public static $form;
 
  public static $validator;
 
  public $emptyValues = array('', 0, array());
 
 
  public function __construct($db)
  {
    global $form, $langs;
 
    $this->db = $db;
    $this->error = '';
    $this->errors = array();
 
    // Type and label
    $this->type = strtolower(substr(get_class($this), 0, -5));
    $this->label = 'FieldLabel' . ucfirst($this->type);
 
    if (!isset(self::$form)) {
      if (!is_object($form)) {
        $form = new Form($this->db);
      }
      self::setForm($form);
    }
 
    if (!isset(self::$validator)) {
      // Use Validate class to allow external Modules to use data validation part instead of concentrate all test here (factoring) or just for reuse
      $validator = new Validate($this->db, $langs);
      self::setValidator($validator);
    }
  }
 
  public static function setForm(&$form)
  {
    self::$form = &$form;
  }
 
  public static function setValidator(&$validator)
  {
    self::$validator = &$validator;
  }
 
  public function clearErrors()
  {
    $this->error = '';
    $this->errors = array();
  }
 
  public function errorsToString($separator = ', ')
  {
    return $this->error . (is_array($this->errors) ? (!empty($this->error) ? $separator : '') . implode($separator, $this->errors) : '');
  }
 
  public function isEmptyValue($fieldInfos, $value, $emptyValues = null)
  {
    if (!isset($value)) {
      return true;
    }
 
    if (!is_array($emptyValues)) {
      $emptyValues = !empty($fieldInfos->emptyValues) && is_array($fieldInfos->emptyValues) ? $fieldInfos->emptyValues : $this->emptyValues;
    }
 
    foreach ($emptyValues as $val) {
      if ($val === $value) {
        return true;
      }
    }
 
    return false;
  }
 
  public function printInputSearchField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    return '';
  }
 
  public function printInputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    return '';
  }
 
  public function printOutputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    return '';
  }
 
  public function getInputCss($fieldInfos, $moreCss = '', $defaultCss = 'minwidth400')
  {
    if (empty($moreCss)) {
      if (!empty($fieldInfos->css)) {
        $moreCss = $fieldInfos->css;
      } elseif (!empty($defaultCss)) {
        $moreCss = $defaultCss;
      }
    }
    $moreCss = trim((string) $moreCss);
 
    return empty($moreCss) ? '' : ' ' . $moreCss;
  }
 
  public function verifyFieldValue($fieldInfos, $key, $value)
  {
    global $langs;
 
    $required = $fieldInfos->required;
    $minLength = $fieldInfos->minLength ?? 0;
    $maxLength = $fieldInfos->maxLength ?? 0;
    //$emptyValues = !empty($fieldInfos->emptyValues) ? $fieldInfos->emptyValues : $this->emptyValues;
 
    // Clear error
    self::$validator->error = '';
 
    // Todo move this in validate class ?
    // Required test and empty value
    if ($this->isEmptyValue($fieldInfos, $value)) {
      if ($required) {
        self::$validator->error = $langs->trans('RequireANotEmptyValue');
        return false;
      } else {
        // if no value sent and the field is not mandatory, no need to perform tests
        return true;
      }
    }
 
    // MIN Size test
    if (!empty($minLength) && is_string($value) && !self::$validator->isMinLength($value, $minLength)) {
      return false;
    }
 
    // MAX Size test
    if (!empty($maxLength) && is_string($value) && !self::$validator->isMaxLength($value, $maxLength)) {
      return false;
    }
 
    // Todo move this in validate class ?
    // MIN Value test
    if (isset($fieldInfos->minValue) && is_numeric($value) && ((float) $value) < $fieldInfos->minValue) {
      self::$validator->error = $langs->trans('RequireMinValue', $fieldInfos->minValue);
      return false;
    }
 
    // MAX Value test
    if (isset($fieldInfos->maxValue) && is_numeric($value) && ((float) $value) > $fieldInfos->maxValue) {
      self::$validator->error = $langs->trans('RequireMaxValue', $fieldInfos->maxValue);
      return false;
    }
 
    return true;
  }
 
  public function verifyPostFieldValue($fieldInfos, $key, $keyPrefix = '', $keySuffix = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    return $this->verifyFieldValue($fieldInfos, $key, GETPOST($htmlName, 'restricthtml'));
  }
 
  public function getPostFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    return $defaultValue;
  }
 
  public function getPostSearchFieldValue($fieldInfos, $key, $defaultValue = null, $keyPrefix = '', $keySuffix = '')
  {
    return $defaultValue;
  }
 
  public function sqlFilterSearchField($fieldInfos, $key, $value)
  {
    return '';
  }
}