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: /**
17: * @template TKey
18: * @template T
19: */
20: interface All
21: {
22: /**
23: * Turns a collection into its array representation.
24: *
25: * Care should be taken when using this method when the collection has potential
26: * duplicate keys. In case keys are preserved, the last of the duplicate keys
27: * will be retained and the previous keys will be lost.
28: *
29: * @param bool $preserveKeys Whether keys will be preserved during conversion.
30: * Set this to `false` to prevent data loss when dealing
31: * with duplicate keys.
32: *
33: * @return ($preserveKeys is false ? list<T> : array<TKey, T>)
34: */
35: public function all(bool $preserveKeys = false): array;
36: }
37: