IntegerDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator\TypeDef;
 
use Wikimedia\ParamValidator\TypeDef;
use Wikimedia\ParamValidator\ValidationException;
 
class IntegerDef extends TypeDef {
 
    const PARAM_IGNORE_RANGE = 'param-ignore-range';
 
    const PARAM_MIN = 'param-min';
 
    const PARAM_MAX = 'param-max';
 
    const PARAM_MAX2 = 'param-max2';
 
    public function validate( $name, $value, array $settings, array $options ) {
        if ( !preg_match( '/^[+-]?\d+$/D', $value ) ) {
            throw new ValidationException( $name, $value, $settings, 'badinteger', [] );
        }
        $ret = intval( $value, 10 );
 
        // intval() returns min/max on overflow, so check that
        if ( $ret === PHP_INT_MAX || $ret === PHP_INT_MIN ) {
            $tmp = ( $ret < 0 ? '-' : '' ) . ltrim( $value, '-0' );
            if ( $tmp !== (string)$ret ) {
                throw new ValidationException( $name, $value, $settings, 'badinteger', [] );
            }
        }
 
        $min = $settings[self::PARAM_MIN] ?? null;
        $max = $settings[self::PARAM_MAX] ?? null;
        $max2 = $settings[self::PARAM_MAX2] ?? null;
        $err = null;
 
        if ( $min !== null && $ret < $min ) {
            $err = 'belowminimum';
            $ret = $min;
        } elseif ( $max !== null && $ret > $max ) {
            if ( $max2 !== null && $this->callbacks->useHighLimits( $options ) ) {
                if ( $ret > $max2 ) {
                    $err = 'abovehighmaximum';
                    $ret = $max2;
                }
            } else {
                $err = 'abovemaximum';
                $ret = $max;
            }
        }
        if ( $err !== null ) {
            $ex = new ValidationException( $name, $value, $settings, $err, [
                'min' => $min === null ? '' : $min,
                'max' => $max === null ? '' : $max,
                'max2' => $max2 === null ? '' : $max2,
            ] );
            if ( empty( $settings[self::PARAM_IGNORE_RANGE] ) ) {
                throw $ex;
            }
            $this->callbacks->recordCondition( $ex, $options );
        }
 
        return $ret;
    }
 
    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 describeSettings( $name, array $settings, array $options ) {
        $info = parent::describeSettings( $name, $settings, $options );
 
        $min = $settings[self::PARAM_MIN] ?? '';
        $max = $settings[self::PARAM_MAX] ?? '';
        $max2 = $settings[self::PARAM_MAX2] ?? '';
        if ( $max === '' || $max2 !== '' && $max2 <= $max ) {
            $max2 = '';
        }
 
        if ( empty( $options['compact'] ) ) {
            if ( $min !== '' ) {
                $info['min'] = $min;
            }
            if ( $max !== '' ) {
                $info['max'] = $max;
            }
            if ( $max2 !== '' ) {
                $info['max2'] = $max2;
            }
        } else {
            $key = '';
            if ( $min !== '' ) {
                $key = 'min';
            }
            if ( $max2 !== '' ) {
                $key .= 'max2';
            } elseif ( $max !== '' ) {
                $key .= 'max';
            }
            if ( $key !== '' ) {
                $info[$key] = [ 'min' => $min, 'max' => $max, 'max2' => $max2 ];
            }
        }
 
        return $info;
    }
 
}