commit vendor

vendor/laminas/laminas-validator/src/Step.php

@@ -0,0 +1,177 @@
+<?php
+
+/**
+ * @see       https://github.com/laminas/laminas-validator for the canonical source repository
+ * @copyright https://github.com/laminas/laminas-validator/blob/master/COPYRIGHT.md
+ * @license   https://github.com/laminas/laminas-validator/blob/master/LICENSE.md New BSD License
+ */
+
+namespace Laminas\Validator;
+
+use Traversable;
+
+class Step extends AbstractValidator
+{
+    const INVALID = 'typeInvalid';
+    const NOT_STEP = 'stepInvalid';
+
+    /**
+     * @var array
+     */
+    protected $messageTemplates = [
+        self::INVALID => 'Invalid value given. Scalar expected',
+        self::NOT_STEP => 'The input is not a valid step',
+    ];
+
+    /**
+     * @var mixed
+     */
+    protected $baseValue = 0;
+
+    /**
+     * @var mixed
+     */
+    protected $step = 1;
+
+    /**
+     * Set default options for this instance
+     *
+     * @param array $options
+     */
+    public function __construct($options = [])
+    {
+        if ($options instanceof Traversable) {
+            $options = iterator_to_array($options);
+        } elseif (! is_array($options)) {
+            $options = func_get_args();
+            $temp['baseValue'] = array_shift($options);
+            if (! empty($options)) {
+                $temp['step'] = array_shift($options);
+            }
+
+            $options = $temp;
+        }
+
+        if (isset($options['baseValue'])) {
+            $this->setBaseValue($options['baseValue']);
+        }
+        if (isset($options['step'])) {
+            $this->setStep($options['step']);
+        }
+
+        parent::__construct($options);
+    }
+
+    /**
+     * Sets the base value from which the step should be computed
+     *
+     * @param mixed $baseValue
+     * @return $this
+     */
+    public function setBaseValue($baseValue)
+    {
+        $this->baseValue = $baseValue;
+        return $this;
+    }
+
+    /**
+     * Returns the base value from which the step should be computed
+     *
+     * @return string
+     */
+    public function getBaseValue()
+    {
+        return $this->baseValue;
+    }
+
+    /**
+     * Sets the step value
+     *
+     * @param mixed $step
+     * @return $this
+     */
+    public function setStep($step)
+    {
+        $this->step = (float) $step;
+        return $this;
+    }
+
+    /**
+     * Returns the step value
+     *
+     * @return string
+     */
+    public function getStep()
+    {
+        return $this->step;
+    }
+
+    /**
+     * Returns true if $value is a scalar and a valid step value
+     *
+     * @param mixed $value
+     * @return bool
+     */
+    public function isValid($value)
+    {
+        if (! is_numeric($value)) {
+            $this->error(self::INVALID);
+            return false;
+        }
+
+        $this->setValue($value);
+
+        $substract = $this->sub($value, $this->baseValue);
+
+        $fmod = $this->fmod($substract, $this->step);
+
+        if ($fmod !== 0.0 && $fmod !== $this->step) {
+            $this->error(self::NOT_STEP);
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * replaces the internal fmod function which give wrong results on many cases
+     *
+     * @param float $x
+     * @param float $y
+     * @return float
+     */
+    protected function fmod($x, $y)
+    {
+        if ($y == 0.0) {
+            return 1.0;
+        }
+
+        //find the maximum precision from both input params to give accurate results
+        $precision = $this->getPrecision($x) + $this->getPrecision($y);
+
+        return round($x - $y * floor($x / $y), $precision);
+    }
+
+    /**
+     * replaces the internal substraction operation which give wrong results on some cases
+     *
+     * @param float $x
+     * @param float $y
+     * @return float
+     */
+    private function sub($x, $y)
+    {
+        $precision = $this->getPrecision($x) + $this->getPrecision($y);
+        return round($x - $y, $precision);
+    }
+
+    /**
+     * @param  float $float
+     * @return int
+     */
+    private function getPrecision($float)
+    {
+        $segment = substr($float, strpos($float, '.') + 1);
+        return $segment ? strlen($segment) : 0;
+    }
+}