FloatDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator\TypeDef;
 
use Wikimedia\Message\MessageValue;
use Wikimedia\ParamValidator\ParamValidator;
 
class FloatDef extends NumericDef {
 
    protected $valueType = 'double';
 
    public function validate( $name, $value, array $settings, array $options ) {
        // Use a regex so as to avoid any potential oddness PHP's default conversion might allow.
        if ( !preg_match( '/^[+-]?(?:\d*\.)?\d+(?:[eE][+-]?\d+)?$/D', $value ) ) {
            $this->failure( 'badfloat', $name, $value, $settings, $options );
        }
 
        $ret = (float)$value;
        if ( !is_finite( $ret ) ) {
            $this->failure( 'badfloat-notfinite', $name, $value, $settings, $options );
        }
 
        return $this->checkRange( $ret, $name, $value, $settings, $options );
    }
 
    private function fixLocaleWeirdness( $value ) {
        $localeData = localeconv();
        if ( $localeData['decimal_point'] !== '.' ) {
            $value = strtr( $value, [
                $localeData['decimal_point'] => '.',
                // PHP's number formatting currently uses only the first byte from 'decimal_point'.
                // See upstream bug https://bugs.php.net/bug.php?id=78113
                $localeData['decimal_point'][0] => '.',
            ] );
        }
        return $value;
    }
 
    public function stringifyValue( $name, $value, array $settings, array $options ) {
        // Ensure sufficient precision for round-tripping. PHP_FLOAT_DIG was added in PHP 7.2.
        $digits = defined( 'PHP_FLOAT_DIG' ) ? PHP_FLOAT_DIG : 15;
        return $this->fixLocaleWeirdness( sprintf( "%.{$digits}g", $value ) );
    }
 
    public function getHelpInfo( $name, array $settings, array $options ) {
        $info = parent::getHelpInfo( $name, $settings, $options );
 
        $info[ParamValidator::PARAM_TYPE] = MessageValue::new( 'paramvalidator-help-type-float' )
            ->params( empty( $settings[ParamValidator::PARAM_ISMULTI] ) ? 1 : 2 );
 
        return $info;
    }
 
}