starsfield.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 StarsField extends CommonField
{
  public $emptyValues = array('', -1);
 
 
  public function printInputSearchField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    global $langs;
 
    $size = (int) $fieldInfos->size;
    $moreCss = $this->getInputCss($fieldInfos, $moreCss);
    $moreAttrib = trim((string) $moreAttrib);
    if (empty($moreAttrib)) $moreAttrib = ' ' . $moreAttrib;
    $value = (int) $value;
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    $options = array();
    for ($i = 0; $i <= $size; $i++) {
      // TODO ajouter la tranduction
      $options[$i] = $langs->trans("StarsFieldValue", $i);
    }
 
    return self::$form->selectarray($htmlName, $options, $value, 1, 0, 0, $moreAttrib, 0, 0, 0, '', $moreCss);
  }
 
  public function printInputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    $size = (int) $fieldInfos->size;
    $moreCss = $this->getInputCss($fieldInfos, $moreCss);
    $moreAttrib = trim((string) $moreAttrib);
    if (empty($moreAttrib)) $moreAttrib = ' ' . $moreAttrib;
    $autoFocus = $fieldInfos->inputAutofocus ? ' autofocus' : '';
    $value = (int) $value;
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    return self::$form->inputStars($htmlName, $size, $value, $moreCss, $moreAttrib . $autoFocus);
  }
 
  public function printOutputField($fieldInfos, $key, $value, $keyPrefix = '', $keySuffix = '', $moreCss = '', $moreAttrib = '')
  {
    $size = (int) $fieldInfos->size;
    $value = (int) $value;
 
    return self::$form->outputStars($size, $value);
  }
 
  public function getInputCss($fieldInfos, $moreCss = '', $defaultCss = '')
  {
    return parent::getInputCss($fieldInfos, $moreCss, $defaultCss);
  }
 
  public function verifyFieldValue($fieldInfos, $key, $value)
  {
    $fieldInfos->minValue = 0;
    $fieldInfos->maxValue = (int) $fieldInfos->size;
 
    $result = parent::verifyFieldValue($fieldInfos, $key, $value);
    if ($result && !$this->isEmptyValue($fieldInfos, $value)) {
      if (!self::$validator->isNumeric($value)) {
        return false;
      }
 
      $result = true;
    }
 
    return $result;
  }
 
  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 = '')
  {
    $htmlName = $keyPrefix . $key . $keySuffix;
 
    if (GETPOSTISSET($htmlName)) {
      $value = GETPOSTINT($htmlName);
    } 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.';
      $value = (int) $value;
 
      if ($value >= 0) {
        return natural_search($alias . ($fieldInfos->nameInTable ?? $key), (string) $value, 1);
      }
    }
 
    return '';
  }
}