class_IntAttribute.inc

<?php
/*
  This code is part of FusionDirectory (http://www.fusiondirectory.org/)
  Copyright (C) 2012-2019  FusionDirectory

  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 2 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, write to the Free Software
  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301, USA.
*/

class IntAttribute extends \FusionDirectory\Core\SimplePlugin\Attribute
{
  protected $min;
  protected $max;
  protected $step = 1;

  function __construct ($label, $description, $ldapName, $required, $min, $max, $defaultValue = "", $acl = "")
  {
    parent::__construct($label, $description, $ldapName, $required, $defaultValue, $acl);
    $this->min      = ($min === FALSE ? FALSE : $this->inputValue($min));
    $this->max      = ($max === FALSE ? FALSE : $this->inputValue($max));
  }

  public function getExample ()
  {
    if (($this->min !== FALSE) && ($this->max !== FALSE)) {
      return sprintf(_('An integer between %d and %d'), $this->min, $this->max);
    } elseif ($this->min !== FALSE) {
      return sprintf(_('An integer larger than %d'),    $this->min);
    } elseif ($this->max !== FALSE) {
      return sprintf(_('An integer smaller than %d'),   $this->max);
    }
  }

  function setStep ($step)
  {
    $this->step = $step;
  }

  function inputValue ($value)
  {
    if (!$this->isRequired() && empty($value) && !is_numeric($value)) {
      // value is "" or array()
      return "";
    }
    if ($this->isTemplate()) {
      return $value;
    } else {
      return intval($value);
    }
  }

  function check ()
  {
    $error = parent::check();
    if (!empty($error)) {
      return $error;
    } elseif ($this->value !== '') {
      if (!is_numeric($this->value)) {
        return new SimplePluginCheckError(
          $this,
          SimplePluginCheckError::invalidValue(sprintf(_('"%s" is not an number'), $this->getValue()))
        );
      }
      if (($this->min !== FALSE) && ($this->value < $this->min)) {
        return new SimplePluginCheckError(
          $this,
          SimplePluginCheckError::invalidValue(sprintf(_('%s is smaller than %s'), $this->getValue(), $this->min))
        );
      }
      if (($this->max !== FALSE) && ($this->value > $this->max)) {
        return new SimplePluginCheckError(
          $this,
          SimplePluginCheckError::invalidValue(sprintf(_('%s is larger than %s'), $this->getValue(), $this->max))
        );
      }
    }
  }

  function renderFormInput (): string
  {
    $id = $this->getHtmlId();
    $attributes = [
      'value' => $this->getValue()
    ];
    if ($this->min !== FALSE) {
      $attributes['min'] = $this->min;
    }
    if ($this->max !== FALSE) {
      $attributes['max'] = $this->max;
    }
    if ($this->step !== FALSE) {
      $attributes['step'] = $this->step;
    }
    if (!empty($this->managedAttributes)) {
      $js       = $this->managedAttributesJS();
      $attributes['onChange'] = 'javascript:'.$js;
    }
    if ($this->isSubAttribute) {
      $attributes['class'] = 'subattribute';
    } elseif ($this->isRequired()) {
      $attributes['required'] = 'required';
    }
    $display = $this->renderInputField('number', $id, $attributes);
    return $this->renderAcl($display);
  }

  function renderTemplateInput (): string
  {
    $id = $this->getHtmlId();
    $attributes = [
      'value' => $this->getValue()
    ];
    if ($this->isSubAttribute) {
      $attributes['class'] = 'subattribute';
    }
    $display = $this->renderInputField('text', $id, $attributes);
    return $this->renderAcl($display);
  }
}

class FloatAttribute extends IntAttribute
{

  function __construct ($label, $description, $ldapName, $required, $min, $max, $defaultValue = 0.0, $acl = "")
  {
    parent::__construct($label, $description, $ldapName, $required, $min, $max, $defaultValue, $acl);

    $this->step = 0.01;
  }

  public function getExample ()
  {
    if (($this->min !== FALSE) && ($this->max !== FALSE)) {
      return sprintf(_('A float between %f and %f'),  $this->min, $this->max);
    } elseif ($this->min !== FALSE) {
      return sprintf(_('A float larger than %f'),     $this->min);
    } elseif ($this->max !== FALSE) {
      return sprintf(_('A float smaller than %f'),    $this->max);
    }
  }

  function inputValue ($value)
  {
    if (!$this->isRequired() && empty($value) && !is_numeric($value)) {
      // value is "" or array()
      return "";
    }
    if ($this->isTemplate()) {
      return $value;
    } else {
      return floatval($value);
    }
  }
}