prepare()

Prepares an array according to the given options: - REDUCE : filter/compress values - BEFORE : prepend keys - AFTER : append keys - FIRST_KEYS + SORT : reorder keys

Parameters

$array : array<int|string, mixed>

The input array.

$options : array{after?: array, before?: array, defaults?: array, exclude?: array|null, firstKeys?: array, include?: array|null, sort?: bool, reduce?: bool|callable|array{clone?: bool, conditions?: callable|array|string|null, depth?: int|null, excludes?: array|null, recursive?: bool, removeKeys?: array|null, throwable?: bool}} = []

Options for transformation (see ArrayOption):

• 'reduce' => bool|array|callable
• 'before' => array
• 'after' => array
• 'firstKeys' => array
• 'sort' => bool

Tags

example

use function oihana\core\arrays\prepare;
use oihana\core\options\ArrayOption;

$result = prepare( [ 'b' => 2, 'a' => 1 ] ,
[
    ArrayOption::FIRST_KEYS => [ 'a' ] ,
    ArrayOption::SORT       => true ,
]);
// [ 'a' => 1, 'b' => 2 ]

author

Marc Alcaraz (ekameleon)

since

1.0.8