Strings\chunk()

transformer returns Closure pure

(int, string) → (string → string)

At a glance — Bind chunk size and separator; the returned Closure breaks strings into fixed-width pieces. Wraps chunk_split().

Allows you to create a function which can be used to break a string with a defined separator, at a numbered interval. 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 The length of each chunk.
  * @param string $end The string to use at the end.
  * @return Closure(string):string
  */
 Strings\chunk(int $length, string $end = "\r\n"):: Closure

Returned Closure

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

/**
  * @param string $string The string to be chunked
  * @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 will chunk a string at 5 characters, with a - as the end.
$chunk5Dash = Strings\chunk(5, '-');

// Called as a function.
echo $chunk5Dash('When Mark eyed this loot Dale shot Mark Dale owns that gold They dont know that'); 
// When -Mark -eyed -this -loot -Dale -shot -Mark -Dale -owns -that -gold -They -dont -know -that-

// Used in a higher order function.
$array = array_map( $chunk5Dash, ['Once upon time', 'John fell like fish food']);
print_r($array); // [Once -upon -time-, John -fell -like -fish -food-]

Curried

This can be called inline using currying.

echo Strings\chunk('2', '*')('Hello World'); // He*ll*o *Wo*rl*d*

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\chunk(2, '_), ['Hello World', 'Foo Bar']);

 print_r($array); // [[He_ll_o _Wo_rl_d_], [Fo_o _Ba_r_]]

Details

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