Sanitize value to be within the given min and max range
If float or decimal string specified for $min or $max arguments, return value will be a float, otherwise an integer is returned.
Available since version 3.0.125.
Example
$n = 10;
$sanitizer->range($n, 100, 200); // returns 100
$sanitizer->range($n, 0, 1.0); // returns 1.0
$sanitizer->range($n, 1.1, 100.5); // returns 10.0
Usage
// basic usage
$int = $sanitizer->range($value);
// usage with all arguments
$int = $sanitizer->range($value, $min = null, $max = null);
Arguments
Name | Type(s) | Description |
---|---|---|
value | int, float, string | |
min (optional) | int, float, string, null | Minimum allowed value or null for no minimum (default=null) |
max (optional) | int, float, string, null | Maximum allowed value or null for no maximum (default=null) |
Return value
int
float
$sanitizer methods and properties
API reference based on ProcessWire core version 3.0.236