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 ) {
        if ( is_float( $value ) ) {
            $ret = $value;
        } elseif ( is_int( $value ) ) {
            $ret = (float)$value;
        } elseif ( $options[ self::OPT_ENFORCE_JSON_TYPES ] ?? false ) {
            $this->fatal(
                $this->failureMessage( 'badfloat-type' )
                    ->params( gettype( $value ) ),
                $name, $value, $settings, $options
            );
        } else {
            if ( !preg_match( '/^[+-]?(?:\d*\.)?\d+(?:[eE][+-]?\d+)?$/D', $value ) ) {
                // Use a regex to avoid any potential oddness PHP's default conversion might allow.
                $this->fatal( 'badfloat', $name, $value, $settings, $options );
            }
 
            $ret = (float)$value;
        }
 
        if ( !is_finite( $ret ) ) {
            $this->fatal( 'badfloat-notfinite', $name, $value, $settings, $options );
        }
 
        return $this->checkRange( $ret, $name, $value, $settings, $options );
    }
 
    public function stringifyValue( $name, $value, array $settings, array $options ) {
        // Ensure sufficient precision for round-tripping
        $digits = PHP_FLOAT_DIG;
        return 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;
    }
 
}