NumericDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator\TypeDef;
 
use Wikimedia\Message\MessageValue;
use Wikimedia\Message\ParamType;
use Wikimedia\Message\ScalarParam;
use Wikimedia\ParamValidator\ParamValidator;
use Wikimedia\ParamValidator\TypeDef;
use Wikimedia\ParamValidator\ValidationException;
 
abstract class NumericDef extends TypeDef {
 
    public const PARAM_IGNORE_RANGE = 'param-ignore-range';
 
    public const PARAM_MIN = 'param-min';
 
    public const PARAM_MAX = 'param-max';
 
    public const PARAM_MAX2 = 'param-max2';
 
    protected $valueType = 'integer';
 
    protected function checkRange( $value, $name, $origValue, array $settings, array $options ) {
        $min = $settings[self::PARAM_MIN] ?? null;
        $max1 = $settings[self::PARAM_MAX] ?? null;
        $max2 = $settings[self::PARAM_MAX2] ?? $max1;
        $err = false;
 
        if ( $min !== null && $value < $min ) {
            $err = true;
            $value = $min;
        } elseif ( $max1 !== null && $value > $max1 ) {
            if ( $max2 > $max1 && $this->callbacks->useHighLimits( $options ) ) {
                if ( $value > $max2 ) {
                    $err = true;
                    $value = $max2;
                }
            } else {
                $err = true;
                $value = $max1;
            }
        }
        if ( $err ) {
            $what = '';
            if ( $min !== null ) {
                $what .= 'min';
            }
            if ( $max1 !== null ) {
                $what .= 'max';
            }
            $max = $max2 !== null && $max2 > $max1 && $this->callbacks->useHighLimits( $options )
                ? $max2 : $max1;
            $this->failure(
                $this->failureMessage( 'outofrange', [
                    'min' => $min,
                    'curmax' => $max,
                    'max' => $max1,
                    'highmax' => $max2,
                ], $what )->numParams( $min ?? '', $max ?? '' ),
                $name, $origValue, $settings, $options,
                empty( $settings[self::PARAM_IGNORE_RANGE] )
            );
        }
 
        return $value;
    }
 
    public function normalizeSettings( array $settings ) {
        if ( !isset( $settings[self::PARAM_MAX] ) ) {
            unset( $settings[self::PARAM_MAX2] );
        }
 
        if ( isset( $settings[self::PARAM_MAX2] ) && isset( $settings[self::PARAM_MAX] ) &&
            $settings[self::PARAM_MAX2] < $settings[self::PARAM_MAX]
        ) {
            $settings[self::PARAM_MAX2] = $settings[self::PARAM_MAX];
        }
 
        return parent::normalizeSettings( $settings );
    }
 
    public function checkSettings( string $name, $settings, array $options, array $ret ): array {
        $ret = parent::checkSettings( $name, $settings, $options, $ret );
 
        $ret['allowedKeys'][] = self::PARAM_IGNORE_RANGE;
        $ret['allowedKeys'][] = self::PARAM_MIN;
        $ret['allowedKeys'][] = self::PARAM_MAX;
        $ret['allowedKeys'][] = self::PARAM_MAX2;
 
        if ( !is_bool( $settings[self::PARAM_IGNORE_RANGE] ?? false ) ) {
            $ret['issues'][self::PARAM_IGNORE_RANGE] = 'PARAM_IGNORE_RANGE must be boolean, got '
                . gettype( $settings[self::PARAM_IGNORE_RANGE] );
        }
 
        $min = $settings[self::PARAM_MIN] ?? null;
        $max = $settings[self::PARAM_MAX] ?? null;
        $max2 = $settings[self::PARAM_MAX2] ?? null;
        if ( $min !== null && gettype( $min ) !== $this->valueType ) {
            $ret['issues'][self::PARAM_MIN] = "PARAM_MIN must be $this->valueType, got " . gettype( $min );
        }
        if ( $max !== null && gettype( $max ) !== $this->valueType ) {
            $ret['issues'][self::PARAM_MAX] = "PARAM_MAX must be $this->valueType, got " . gettype( $max );
        }
        if ( $max2 !== null && gettype( $max2 ) !== $this->valueType ) {
            $ret['issues'][self::PARAM_MAX2] = "PARAM_MAX2 must be $this->valueType, got "
                . gettype( $max2 );
        }
 
        if ( $min !== null && $max !== null && $min > $max ) {
            $ret['issues'][] = "PARAM_MIN must be less than or equal to PARAM_MAX, but $min > $max";
        }
        if ( $max2 !== null ) {
            if ( $max === null ) {
                $ret['issues'][] = 'PARAM_MAX2 cannot be used without PARAM_MAX';
            } elseif ( $max2 < $max ) {
                $ret['issues'][] = "PARAM_MAX2 must be greater than or equal to PARAM_MAX, but $max2 < $max";
            }
        }
 
        return $ret;
    }
 
    public function getParamInfo( $name, array $settings, array $options ) {
        $info = parent::getParamInfo( $name, $settings, $options );
 
        $info['min'] = $settings[self::PARAM_MIN] ?? null;
        $info['max'] = $settings[self::PARAM_MAX] ?? null;
        $info['highmax'] = $settings[self::PARAM_MAX2] ?? $info['max'];
        if ( $info['max'] === null || $info['highmax'] <= $info['max'] ) {
            unset( $info['highmax'] );
        }
 
        return $info;
    }
 
    public function getHelpInfo( $name, array $settings, array $options ) {
        $info = parent::getHelpInfo( $name, $settings, $options );
 
        $min = '−∞';
        $max = '∞';
        $msg = '';
        if ( isset( $settings[self::PARAM_MIN] ) ) {
            $msg .= 'min';
            $min = new ScalarParam( ParamType::NUM, $settings[self::PARAM_MIN] );
        }
        if ( isset( $settings[self::PARAM_MAX] ) ) {
            $msg .= 'max';
            $max = $settings[self::PARAM_MAX];
            if ( isset( $settings[self::PARAM_MAX2] ) && $settings[self::PARAM_MAX2] > $max &&
                $this->callbacks->useHighLimits( $options )
            ) {
                $max = $settings[self::PARAM_MAX2];
            }
            $max = new ScalarParam( ParamType::NUM, $max );
        }
        if ( $msg !== '' ) {
            $isMulti = !empty( $settings[ParamValidator::PARAM_ISMULTI] );
 
            // Messages: paramvalidator-help-type-number-min, paramvalidator-help-type-number-max,
            // paramvalidator-help-type-number-minmax
            $info[self::PARAM_MIN] = MessageValue::new( "paramvalidator-help-type-number-$msg" )
                ->params( $isMulti ? 2 : 1, $min, $max );
        }
 
        return $info;
    }
 
}