BooleanDef.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\ParamValidator\TypeDef;
 
use Wikimedia\ParamValidator\TypeDef;
use Wikimedia\ParamValidator\ValidationException;
 
class BooleanDef extends TypeDef {
 
    public static $TRUEVALS = [ 'true', 't', 'yes', 'y', 'on', '1' ];
    public static $FALSEVALS = [ 'false', 'f', 'no', 'n', 'off', '0' ];
 
    public function validate( $name, $value, array $settings, array $options ) {
        $value = strtolower( $value );
        if ( in_array( $value, self::$TRUEVALS, true ) ) {
            return true;
        }
        if ( $value === '' || in_array( $value, self::$FALSEVALS, true ) ) {
            return false;
        }
 
        throw new ValidationException( $name, $value, $settings, 'badbool', [
            'truevals' => self::$TRUEVALS,
            'falsevals' => array_merge( self::$FALSEVALS, [ 'the empty string' ] ),
        ] );
    }
 
    public function stringifyValue( $name, $value, array $settings, array $options ) {
        return $value ? self::$TRUEVALS[0] : self::$FALSEVALS[0];
    }
 
}