$sanitizer→max()

Sanitize to have a maximuim value

If float or decimal string specified for $max argument, return value will be a float, otherwise an integer is returned.

Available since version 3.0.125.

Example

$n = 10;
$sanitizer->max(5); // returns 5
$sanitizer->max(100); // returns 10
$sanitizer->max100.0; // returns 10.0

Usage

// basic usage
$int = $sanitizer->max($value);

// usage with all arguments
$int = $sanitizer->max($value, $max = 9223372036854775807);

Arguments

NameType(s)Description
$valueint float string
$max (optional)int float string

Maximum allowed value

Return value

int float

See Also

$sanitizer methods and properties

API reference based on ProcessWire core version 3.0.252