Automattic\WooCommerce\Utilities
NumberUtil{}
A class of utilities for dealing with numbers.
No Hooks.
Usage
$NumberUtil = new NumberUtil(); // use class methods
Methods
- public static array_sum( array $arr )
- public static round( $val, int $precision = 0, int $mode = PHP_ROUND_HALF_UP )
NumberUtil{} NumberUtil{} code WC 9.4.2
final class NumberUtil { /** * Round a number using the built-in `round` function, but unless the value to round is numeric * (a number or a string that can be parsed as a number), apply 'floatval' first to it * (so it will convert it to 0 in most cases). * * This is needed because in PHP 7 applying `round` to a non-numeric value returns 0, * but in PHP 8 it throws an error. Specifically, in WooCommerce we have a few places where * round('') is often executed. * * @param mixed $val The value to round. * @param int $precision The optional number of decimal digits to round to. * @param int $mode A constant to specify the mode in which rounding occurs. * * @return float The value rounded to the given precision as a float, or the supplied default value. */ public static function round( $val, int $precision = 0, int $mode = PHP_ROUND_HALF_UP ) : float { if ( ! is_numeric( $val ) ) { $val = floatval( $val ); } return round( $val, $precision, $mode ); } /** * Get the sum of an array of values using the built-in array_sum function, but sanitize the array values * first to ensure they are all floats. * * This is needed because in PHP 8.3 non-numeric values that cannot be cast as an int or a float will * cause an E_WARNING to be emitted. Prior to PHP 8.3 these values were just ignored. * * Note that, unlike the built-in array_sum, this one will always return a float, never an int. * * @param array $arr The array of values to sum. * * @return float */ public static function array_sum( array $arr ): float { $sanitized_array = array_map( 'floatval', $arr ); return array_sum( $sanitized_array ); } }