| 1: | <?php declare(strict_types=1); |
| 2: | |
| 3: | namespace Salient\Contract\Collection; |
| 4: | |
| 5: | use Salient\Contract\Core\Arrayable; |
| 6: | use Salient\Contract\Core\Jsonable; |
| 7: | use ArrayAccess; |
| 8: | use Countable; |
| 9: | use JsonSerializable; |
| 10: | use OutOfRangeException; |
| 11: | use Traversable; |
| 12: | |
| 13: | /** |
| 14: | * @api |
| 15: | * |
| 16: | * @template TKey of array-key |
| 17: | * @template TValue |
| 18: | * |
| 19: | * @extends ArrayAccess<TKey,TValue> |
| 20: | * @extends Traversable<TKey,TValue> |
| 21: | * @extends Arrayable<TKey,TValue|mixed[]> |
| 22: | */ |
| 23: | interface CollectionInterface extends |
| 24: | ArrayAccess, |
| 25: | Countable, |
| 26: | JsonSerializable, |
| 27: | Traversable, |
| 28: | Arrayable, |
| 29: | Jsonable |
| 30: | { |
| 31: | /** |
| 32: | * Pass the value of each item to the callback |
| 33: | */ |
| 34: | public const CALLBACK_USE_VALUE = 1; |
| 35: | |
| 36: | /** |
| 37: | * Pass the key of each item to the callback |
| 38: | */ |
| 39: | public const CALLBACK_USE_KEY = 2; |
| 40: | |
| 41: | /** |
| 42: | * Pass a key-value pair to the callback for each item |
| 43: | */ |
| 44: | public const CALLBACK_USE_BOTH = 3; |
| 45: | |
| 46: | /** |
| 47: | * Return the first item that satisfies the callback |
| 48: | */ |
| 49: | public const FIND_VALUE = 8; |
| 50: | |
| 51: | /** |
| 52: | * Return the key of the first item that satisfies the callback |
| 53: | */ |
| 54: | public const FIND_KEY = 16; |
| 55: | |
| 56: | /** |
| 57: | * @param Arrayable<TKey,TValue>|iterable<TKey,TValue> $items |
| 58: | */ |
| 59: | public function __construct($items = []); |
| 60: | |
| 61: | /** |
| 62: | * Check if the collection is empty |
| 63: | * |
| 64: | * @phpstan-assert-if-false non-empty-array<TKey,TValue> $this->all() |
| 65: | * @phpstan-assert-if-false !null $this->first() |
| 66: | * @phpstan-assert-if-false !null $this->last() |
| 67: | */ |
| 68: | public function isEmpty(): bool; |
| 69: | |
| 70: | /** |
| 71: | * Add or replace an item with a given key |
| 72: | * |
| 73: | * @param TKey $key |
| 74: | * @param TValue $value |
| 75: | * @return static |
| 76: | */ |
| 77: | public function set($key, $value); |
| 78: | |
| 79: | /** |
| 80: | * Check if an item with a given key exists |
| 81: | * |
| 82: | * @param TKey $key |
| 83: | * @phpstan-assert-if-true non-empty-array<TKey,TValue> $this->all() |
| 84: | * @phpstan-assert-if-true !null $this->first() |
| 85: | * @phpstan-assert-if-true !null $this->last() |
| 86: | */ |
| 87: | public function has($key): bool; |
| 88: | |
| 89: | /** |
| 90: | * Get the item with the given key |
| 91: | * |
| 92: | * @param TKey $key |
| 93: | * @return TValue |
| 94: | * @throws OutOfRangeException if there is no such item in the collection. |
| 95: | */ |
| 96: | public function get($key); |
| 97: | |
| 98: | /** |
| 99: | * Remove an item with a given key |
| 100: | * |
| 101: | * @param TKey $key |
| 102: | * @return static |
| 103: | */ |
| 104: | public function unset($key); |
| 105: | |
| 106: | /** |
| 107: | * Add an item |
| 108: | * |
| 109: | * @param TValue $value |
| 110: | * @return static<TKey|int,TValue> |
| 111: | */ |
| 112: | public function add($value); |
| 113: | |
| 114: | /** |
| 115: | * Merge the collection with the given items |
| 116: | * |
| 117: | * @param Arrayable<TKey,TValue>|iterable<TKey,TValue> $items |
| 118: | * @return static |
| 119: | */ |
| 120: | public function merge($items); |
| 121: | |
| 122: | /** |
| 123: | * Sort items in the collection |
| 124: | * |
| 125: | * @return static |
| 126: | */ |
| 127: | public function sort(); |
| 128: | |
| 129: | /** |
| 130: | * Reverse the order of items in the collection |
| 131: | * |
| 132: | * @return static |
| 133: | */ |
| 134: | public function reverse(); |
| 135: | |
| 136: | /** |
| 137: | * Pass each item in the collection to a callback |
| 138: | * |
| 139: | * The callback's return values are discarded. |
| 140: | * |
| 141: | * @template TMode of int-mask-of<CollectionInterface::*> |
| 142: | * |
| 143: | * @param (callable(TValue, TValue|null $next, TValue|null $prev): mixed)|(callable(TKey, TKey|null $next, TKey|null $prev): mixed)|(callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): mixed) $callback |
| 144: | * @phpstan-param ( |
| 145: | * TMode is 3|11|19 |
| 146: | * ? (callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): mixed) |
| 147: | * : (TMode is 2|10|18 |
| 148: | * ? (callable(TKey, TKey|null $next, TKey|null $prev): mixed) |
| 149: | * : (callable(TValue, TValue|null $next, TValue|null $prev): mixed) |
| 150: | * ) |
| 151: | * ) $callback |
| 152: | * @param TMode $mode |
| 153: | * @return $this |
| 154: | */ |
| 155: | public function forEach(callable $callback, int $mode = CollectionInterface::CALLBACK_USE_VALUE); |
| 156: | |
| 157: | /** |
| 158: | * Pass each item in the collection to a callback and populate a new |
| 159: | * collection with its return values |
| 160: | * |
| 161: | * @template TMode of int-mask-of<CollectionInterface::*> |
| 162: | * @template TReturn of TValue |
| 163: | * |
| 164: | * @param (callable(TValue, TValue|null $next, TValue|null $prev): TReturn)|(callable(TKey, TKey|null $next, TKey|null $prev): TReturn)|(callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): TReturn) $callback |
| 165: | * @phpstan-param ( |
| 166: | * TMode is 3|11|19 |
| 167: | * ? (callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): TReturn) |
| 168: | * : (TMode is 2|10|18 |
| 169: | * ? (callable(TKey, TKey|null $next, TKey|null $prev): TReturn) |
| 170: | * : (callable(TValue, TValue|null $next, TValue|null $prev): TReturn) |
| 171: | * ) |
| 172: | * ) $callback |
| 173: | * @param TMode $mode |
| 174: | * @return static<TKey,TReturn> |
| 175: | */ |
| 176: | public function map(callable $callback, int $mode = CollectionInterface::CALLBACK_USE_VALUE); |
| 177: | |
| 178: | /** |
| 179: | * Reduce the collection to items that satisfy a callback |
| 180: | * |
| 181: | * @template TMode of int-mask-of<CollectionInterface::*> |
| 182: | * |
| 183: | * @param (callable(TValue, TValue|null $next, TValue|null $prev): bool)|(callable(TKey, TKey|null $next, TKey|null $prev): bool)|(callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): bool) $callback |
| 184: | * @phpstan-param ( |
| 185: | * TMode is 3|11|19 |
| 186: | * ? (callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): bool) |
| 187: | * : (TMode is 2|10|18 |
| 188: | * ? (callable(TKey, TKey|null $next, TKey|null $prev): bool) |
| 189: | * : (callable(TValue, TValue|null $next, TValue|null $prev): bool) |
| 190: | * ) |
| 191: | * ) $callback |
| 192: | * @param TMode $mode |
| 193: | * @return static |
| 194: | */ |
| 195: | public function filter(callable $callback, int $mode = CollectionInterface::CALLBACK_USE_VALUE); |
| 196: | |
| 197: | /** |
| 198: | * Get the first item that satisfies a callback, or null if there is no such |
| 199: | * item in the collection |
| 200: | * |
| 201: | * @template TMode of int-mask-of<CollectionInterface::*> |
| 202: | * |
| 203: | * @param (callable(TValue, TValue|null $next, TValue|null $prev): bool)|(callable(TKey, TKey|null $next, TKey|null $prev): bool)|(callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): bool) $callback |
| 204: | * @phpstan-param ( |
| 205: | * TMode is 3|11|19 |
| 206: | * ? (callable(array{TKey,TValue}, array{TKey,TValue}|null $next, array{TKey,TValue}|null $prev): bool) |
| 207: | * : (TMode is 2|10|18 |
| 208: | * ? (callable(TKey, TKey|null $next, TKey|null $prev): bool) |
| 209: | * : (callable(TValue, TValue|null $next, TValue|null $prev): bool) |
| 210: | * ) |
| 211: | * ) $callback |
| 212: | * @param TMode $mode |
| 213: | * @return (TMode is 16|17|18|19 ? TKey : TValue)|null |
| 214: | */ |
| 215: | public function find(callable $callback, int $mode = CollectionInterface::CALLBACK_USE_VALUE | CollectionInterface::FIND_VALUE); |
| 216: | |
| 217: | /** |
| 218: | * Reduce the collection to items with keys in an array |
| 219: | * |
| 220: | * @param TKey[] $keys |
| 221: | * @return static |
| 222: | */ |
| 223: | public function only(array $keys); |
| 224: | |
| 225: | /** |
| 226: | * Reduce the collection to items with keys in an index |
| 227: | * |
| 228: | * @param array<TKey,true> $index |
| 229: | * @return static |
| 230: | */ |
| 231: | public function onlyIn(array $index); |
| 232: | |
| 233: | /** |
| 234: | * Reduce the collection to items with keys not in an array |
| 235: | * |
| 236: | * @param TKey[] $keys |
| 237: | * @return static |
| 238: | */ |
| 239: | public function except(array $keys); |
| 240: | |
| 241: | /** |
| 242: | * Reduce the collection to items with keys not in an index |
| 243: | * |
| 244: | * @param array<TKey,true> $index |
| 245: | * @return static |
| 246: | */ |
| 247: | public function exceptIn(array $index); |
| 248: | |
| 249: | /** |
| 250: | * Extract a slice of the collection |
| 251: | * |
| 252: | * @return static |
| 253: | */ |
| 254: | public function slice(int $offset, ?int $length = null); |
| 255: | |
| 256: | /** |
| 257: | * Check if a value is in the collection |
| 258: | * |
| 259: | * @param TValue $value |
| 260: | * @phpstan-assert-if-true non-empty-array<TKey,TValue> $this->all() |
| 261: | * @phpstan-assert-if-true !null $this->first() |
| 262: | * @phpstan-assert-if-true !null $this->last() |
| 263: | */ |
| 264: | public function hasValue($value, bool $strict = false): bool; |
| 265: | |
| 266: | /** |
| 267: | * Get the first key at which a value is found, or null if it's not in the |
| 268: | * collection |
| 269: | * |
| 270: | * @param TValue $value |
| 271: | * @return TKey|null |
| 272: | */ |
| 273: | public function keyOf($value, bool $strict = false); |
| 274: | |
| 275: | /** |
| 276: | * Get the first item equal but not necessarily identical to a value, or |
| 277: | * null if it's not in the collection |
| 278: | * |
| 279: | * @param TValue $value |
| 280: | * @return TValue|null |
| 281: | */ |
| 282: | public function firstOf($value); |
| 283: | |
| 284: | /** |
| 285: | * Get all items in the collection |
| 286: | * |
| 287: | * @return array<TKey,TValue> |
| 288: | */ |
| 289: | public function all(): array; |
| 290: | |
| 291: | /** |
| 292: | * Get the first item, or null if the collection is empty |
| 293: | * |
| 294: | * @return TValue|null |
| 295: | */ |
| 296: | public function first(); |
| 297: | |
| 298: | /** |
| 299: | * Get the last item, or null if the collection is empty |
| 300: | * |
| 301: | * @return TValue|null |
| 302: | */ |
| 303: | public function last(); |
| 304: | |
| 305: | /** |
| 306: | * Get the nth item (1-based), or null if there is no such item in the |
| 307: | * collection |
| 308: | * |
| 309: | * If `$n` is negative, the nth item from the end of the collection is |
| 310: | * returned. |
| 311: | * |
| 312: | * @return TValue|null |
| 313: | */ |
| 314: | public function nth(int $n); |
| 315: | |
| 316: | /** |
| 317: | * Push items onto the end of the collection |
| 318: | * |
| 319: | * @param TValue ...$items |
| 320: | * @return static<TKey|int,TValue> |
| 321: | */ |
| 322: | public function push(...$items); |
| 323: | |
| 324: | /** |
| 325: | * Pop an item off the end of the collection |
| 326: | * |
| 327: | * @param TValue|null $last Receives the value removed from the collection, |
| 328: | * or `null` if the collection is empty. |
| 329: | * @return static |
| 330: | */ |
| 331: | public function pop(&$last = null); |
| 332: | |
| 333: | /** |
| 334: | * Shift an item off the beginning of the collection |
| 335: | * |
| 336: | * @param TValue|null $first Receives the value removed from the collection, |
| 337: | * or `null` if the collection is empty. |
| 338: | * @return static |
| 339: | */ |
| 340: | public function shift(&$first = null); |
| 341: | |
| 342: | /** |
| 343: | * Add items to the beginning of the collection |
| 344: | * |
| 345: | * Items are added in one operation and stay in the given order. |
| 346: | * |
| 347: | * @param TValue ...$items |
| 348: | * @return static<TKey|int,TValue> |
| 349: | */ |
| 350: | public function unshift(...$items); |
| 351: | } |
| 352: |