1: <?php
2:
3: declare(strict_types=1);
4:
5: /**
6: * This file is part of the Nexus framework.
7: *
8: * (c) John Paul E. Balandan, CPA <paulbalandan@gmail.com>
9: *
10: * For the full copyright and license information, please view
11: * the LICENSE file that was distributed with this source code.
12: */
13:
14: namespace Nexus\Collection\Operation;
15:
16: use Nexus\Collection\CollectionInterface;
17:
18: /**
19: * @template TKey
20: * @template T
21: */
22: interface MapWithKey
23: {
24: /**
25: * Returns a new collection consisting of items transformed by the
26: * mapping function `$predicate` that accepts the keys and values
27: * as inputs. The keys are left unchanged.
28: *
29: * @template U
30: *
31: * @param (\Closure(T, TKey): U) $predicate
32: *
33: * @return CollectionInterface<TKey, U>
34: */
35: public function mapWithKey(\Closure $predicate): CollectionInterface;
36: }
37: