Strings\pad()

transformer returns Closure pure

(int, string, int) → (string → string)

At a glance — Bind length, fill, and direction up front. Wraps str_pad().

Allows you to create a function which can be used to pad a string to a defined length, with a defined string. These can either be used as part of a Higher Order Function such as array_map() or as part of a compiled/pipe function.

/**
  * @param int $length Max length to make string.
  * @param string $padContent The value to padd the string with (defaults to ' ')
  * @param int $type How to pad, please use these constants. STR_PAD_RIGHT|STR_PAD_LEFT|STR_PAD_BOTH
  * @return Closure(string):string
  */
 Strings\pad(int $length, string $padContent = ' ', int $type = STR_PAD_RIGHT): Closure

Returned Closure

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

/**
  * @param string $string The string to pad out.
  * @return string
  * @psalm-pure
  */ 
$function(string $string): string

Examples

Partial Application

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

// Create a closure which can be used to pad a string to 20 characters, with a - as the pad content.
$padLeft = Strings\pad(20, '-', STR_PAD_LEFT);
$padRight = Strings\pad(20, '-', STR_PAD_RIGHT);
$padBoth = Strings\pad(20, '-', STR_PAD_BOTH);

// Called as a function.
echo $padLeft('Hello World'); // ------------Hello World
echo $padRight('Hello World'); // Hello World------------
echo $padBoth('Hello World'); // -----Hello World-----

// Used in a higher order function.
$array = array_map( $padLeft, ['Once upon time', 'Find the time']);
print_r($array); // [------Once upon time, -------Find the time]

Curried

This can be called inline using currying.

// Padding right is the default, so can be omitted.
echo Strings\pad(20, '-')('Hello World'); // Hello World---------

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\pad(20, '-', STR_PAD_BOTH), ['Once upon time', 'Find the time']);
print_r($array); // [---Once upon time---, ---Find the time----]

Details

Group: Strings
Subgroup: String manipulation
Core Functions: str_pad()
Since: 0.1.0
Source: