Arrays\ksort()

transformer terminal accepts iterable returns Closure pure
int → (Iterable → T[])
At a glance — Sort by key, keep keys. Terminal on Generator input.

Creates a Closure that sorts an array or iterable by key in ascending order, preserving key-value associations.

/**
  * @param int $flag PHP sort flag constant.
  * @return Closure(iterable<int|string, mixed>):mixed[]
  */
Arrays\ksort(int $flag = SORT_REGULAR): Closure

Returned Closure

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

/**
  * @param iterable<int|string, mixed> $source
  * @return mixed[]
  */
$function (iterable $source): array

Examples

Partial Application

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

$byKey = Arrays\ksort();
print_r($byKey(['b' => 2, 'a' => 1]));
// ['a' => 1, 'b' => 2]

Details

Arrays Functions

Releated Array sort Functions