Strings\digit()

transformer returns Closure pure

(number, string, string) → (number → string)

At a glance — Bind formatting rules up front; the returned Closure number_formats any number. Always returns a string.

Creates a function which allows for the casting of a string to a decimal number. The created function can then reused over any string, or used as part of a Higher Order Function such as array_map().

/**
  * @param string|int|float $precision Number of decimal places
  * @param string $decimal The decimal separator
  * @param string $thousands The thousand separator.
  * @return Closure(string|int|float):string
  */
Strings\digit($precision = 2, $decimal = '.', $thousands = ''): Closure

Returned Closure

When Strings\digit() is called, it returns the following Closure which can be used like a regular function.

/**
 * @param string|int|float $number
 * @return string
 */
$function (string|int|float $string): string

Examples

Partial Application

This can be used to create a simple closure which can be used as a regular function.

// Create the closure that will format a number to 2 decimal places with , as 1000 separator.
$format = Strings\digit(2, '.', ',');

// Called as a function.
echo $format(1234.56); // 1,234.56
echo $format(1234); // 1,234.00

// Used in a higher order function.
$array = array_map($format, [1234.56, 1234]);
print_r($array); /// ['1,234.56', '1,234.00']

// By default the precision is 2, "." is used for the decimal point and no thousands separator is used.
echo $format(1234.56); // 1,234.56

Curried

This can be called inline using currying.

// With decimal full stop and comma as thousands separator.
echo Strings\digit(2, '.', ',')(1234.56); // 1,234.56

// With decimal comma and no thousands separator.
echo Strings\digit(2, ',', '.')(1234); // 1.234,00

Inlined with Higher Order Function

If you are not planning on reusing the Closure created, you can just call it inline with a higher order function as its callable.

$array = array_map( Strings\replaceSubString('...', 3), ['This is an example', 'Another example'] );
print_r($array); // ['Thi...', 'Ano...']

$array = array_map( Strings\replaceSubString('...', -3), ['This is an example', 'Another example'] );
print_r($array); // ['This is an ex...', 'Another ex...']

$array = array_map( Strings\replaceSubString('...', 5, 2), ['This is an example', 'Another example'] );
print_r($array); // ['This ... an example', 'Another ... an example']

$array = array_map( Strings\replaceSubString('...', 5, 0), ['This is an example', 'Another example'] );
print_r($array); // ['This ... is an example', 'Another ... is an example']

Details

Group: Strings
Subgroup: String transform
Core Functions: number_format()
Since: 0.3.0
Source: