Arrays\flattenByN()
int? → (Iterable → Iterable)
At a glance — Depth-limited flatten. Pass null (or no argument) to flatten fully. Lazy on Generator input.
Creates a Closure that flattens nested arrays up to a specified depth. Empty nested arrays are dropped.
/**
* @param int|null $n Depth to flatten. Null = fully.
* @return Closure(iterable<int|string, mixed>):(array<int, mixed>|\Generator<int, mixed>)
*/
Arrays\flattenByN(?int $n = null): ClosureReturned Closure
When Arrays\flattenByN() is called, it returns the following Closure which can be used like a regular function.
/**
* @param iterable<int|string, mixed> $source
* @return array<int, mixed>|\Generator<int, mixed>
*/
$function (iterable $source): array|\GeneratorExamples
Partial Application
This can be used to create a simple closure which can be used as a regular function.
$flatOne = Arrays\flattenByN(1);
print_r($flatOne([1, [2, [3, 4]], 5]));
// [1, 2, [3, 4], 5]
$flatAll = Arrays\flattenByN();
print_r($flatAll([1, [2, [3, 4]], 5]));
// [1, 2, 3, 4, 5]Curried
This can be called inline using currying.
print_r(Arrays\flattenByN(2)([[[1]], [[2], [3]]]));
// [1, [2], [3]] // wait — 2 levels deepDetails
- Group: Arrays
- Subgroup: Array manipulation
- Since: 0.1.0
- Source:
Arrays Functions
- Arrays\append()
- Arrays\arrayCompiler()
- Arrays\arrayCompilerTyped()
- Arrays\arsort()
- Arrays\asort()
- Arrays\chunk()
- Arrays\column()
- Arrays\each()
- Arrays\filter()
- Arrays\filterAll()
- Arrays\filterAnd()
- Arrays\filterAny()
- Arrays\filterCount()
- Arrays\filterFirst()
- Arrays\filterKey()
- Arrays\filterLast()
- Arrays\filterMap()
- Arrays\filterOr()
- Arrays\flatMap()
- Arrays\flattenByN()
- Arrays\fold()
- Arrays\foldKeys()
- Arrays\foldR()
- Arrays\groupBy()
- Arrays\head()
- Arrays\krsort()
- Arrays\ksort()
- Arrays\last()
- Arrays\map()
- Arrays\mapKey()
- Arrays\mapWith()
- Arrays\mapWithKey()
- Arrays\natcasesort()
- Arrays\natsort()
- Arrays\partition()
- Arrays\pick()
- Arrays\prepend()
- Arrays\replace()
- Arrays\replaceRecursive()
- Arrays\rsort()
- Arrays\scan()
- Arrays\scanR()
- Arrays\sort()
- Arrays\sumWhere()
- Arrays\tail()
- Arrays\take()
- Arrays\takeLast()
- Arrays\takeUntil()
- Arrays\takeWhile()
- Arrays\toJson()
- Arrays\toObject()
- Arrays\toString()
- Arrays\uasort()
- Arrays\uksort()
- Arrays\usort()
- Arrays\zip()