Interface Salient\Contract\Collection\CollectionInterface

`<TKey is array-key, TValue>`

`extends`	`ArrayAccess<TKey, TValue>, Arrayable<TKey, TValue\|mixed[]>, Countable, IteratorAggregate<TKey, TValue>, JsonSerializable, Jsonable`

An array-like collection of items

Salient\Contract\Collection\CollectionInterface extends ArrayAccess<TKey, TValue>, Arrayable<TKey, TValue|mixed[]>, Countable, IteratorAggregate<TKey, TValue>, JsonSerializable, Jsonable
- Salient\Collection\AbstractTypedCollection implements CollectionInterface<TKey, TValue> uses CollectionTrait
  - Salient\Sync\Support\SyncErrorCollection implements SyncErrorCollectionInterface
- Salient\Collection\Collection implements CollectionInterface<TKey, TValue> uses CollectionTrait
- Salient\Collection\ImmutableCollection implements CollectionInterface<TKey, TValue>, Immutable uses ImmutableCollectionTrait
- Salient\Contract\Sync\SyncErrorCollectionInterface extends CollectionInterface<int, SyncErrorInterface>, Stringable
  - Salient\Sync\Support\SyncErrorCollection implements SyncErrorCollectionInterface
- Salient\Contract\Http\HttpHeadersInterface extends CollectionInterface<string, string[]>, Immutable, Stringable
  - Salient\Http\HttpHeaders implements HttpHeadersInterface uses ReadableCollectionTrait, ImmutableArrayAccessTrait, HasMutator
- Salient\Contract\Collection\ListInterface extends CollectionInterface<int, TValue>
  - Salient\Collection\ImmutableListCollection implements ListInterface<TValue>, Immutable uses ImmutableListTrait
  - Salient\Collection\AbstractTypedList implements ListInterface<TValue> uses ListTrait
  - Salient\Collection\ListCollection implements ListInterface<TValue> uses ListTrait

Located at Toolkit/Contract/Collection/CollectionInterface.php

Methods


					
	public

__construct(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items = [])

Implemented by

Salient\Http\HttpHeaders::__construct()


					
	public
					static

empty(): static

Get a new collection with no items


					
	public

copy(): static

Get a copy of the collection


					
	public

set(TKey $key, TValue $value): static

Add or replace an item with a given key

Implemented by

Salient\Http\HttpHeaders::set()


					
	public

has(TKey $key): bool

Check if an item with a given key exists


					
	public

get(TKey $key): TValue

Get the item with the given key

Throws

OutOfRangeException

if there is no such item in the collection.


					
	public

unset(TKey $key): static

Remove an item with a given key

Implemented by

Salient\Http\HttpHeaders::unset()


					
	public

merge(Arrayable<TKey, TValue>|iterable<TKey, TValue> $items): static

Merge the collection with the given items

Implemented by

Salient\Http\HttpHeaders::merge()


					
	public

sort(): static

Sort items in the collection

Implemented by

Salient\Http\HttpHeaders::sort()


					
	public

reverse(): static

Reverse the order of items in the collection

Implemented by

Salient\Http\HttpHeaders::reverse()


					
	public

forEach<T is TValue|TKey|array{TKey, TValue}>(
	callable(T, T|null $next, T|null $prev): mixed $callback,
	int-mask-of<CollectionInterface::*> $mode = CollectionInterface::CALLBACK_USE_VALUE,
): $this

Pass each item in the collection to a callback

The callback's return values are discarded.


					
	public

map<T is TValue|TKey|array{TKey, TValue}, TReturn>(
	callable(T, T|null $next, T|null $prev): TReturn $callback,
	int-mask-of<CollectionInterface::*> $mode = CollectionInterface::CALLBACK_USE_VALUE,
): static<TKey, TReturn>

Pass each item in the collection to a callback and populate a new collection with its return values

Implemented by

Salient\Http\HttpHeaders::map()


					
	public

filter<T is TValue|TKey|array{TKey, TValue}>(
	callable(T, T|null $next, T|null $prev): bool $callback,
	int-mask-of<CollectionInterface::*> $mode = CollectionInterface::CALLBACK_USE_VALUE,
): static

Reduce the collection to items that satisfy a callback

Implemented by

Salient\Http\HttpHeaders::filter()


					
	public

find<T is TValue|TKey|array{TKey, TValue}>(
	callable(T, T|null $next, T|null $prev): bool $callback,
	int-mask-of<CollectionInterface::*> $mode = CollectionInterface::CALLBACK_USE_VALUE | CollectionInterface::FIND_VALUE,
): ($mode is 8|9|10|11 ? TKey : TValue)|null

Get the first item that satisfies a callback, or null if there is no such item in the collection


					
	public

only(TKey[] $keys): static

Reduce the collection to items with keys in an array

Implemented by

Salient\Http\HttpHeaders::only()


					
	public

onlyIn(array<TKey, true> $index): static

Reduce the collection to items with keys in an index

Implemented by

Salient\Http\HttpHeaders::onlyIn()


					
	public

except(TKey[] $keys): static

Reduce the collection to items with keys not in an array

Implemented by

Salient\Http\HttpHeaders::except()


					
	public

exceptIn(array<TKey, true> $index): static

Reduce the collection to items with keys not in an index

Implemented by

Salient\Http\HttpHeaders::exceptIn()


					
	public

slice(int $offset, ?int $length = null): static

Extract a slice of the collection

Implemented by

Salient\Http\HttpHeaders::slice()


					
	public

hasValue(TValue $value, bool $strict = false): bool

Check if a value is in the collection


					
	public

keyOf(TValue $value, bool $strict = false): TKey|null

Get the first key at which a value is found, or null if it's not in the collection


					
	public

firstOf(TValue $value): TValue|null

Get the first item equal but not necessarily identical to a value, or null if it's not in the collection


					
	public

all(): array<TKey, TValue>

Get all items in the collection


					
	public

first(): TValue|null

Get the first item, or null if the collection is empty


					
	public

last(): TValue|null

Get the last item, or null if the collection is empty


					
	public

nth(int $n): TValue|null

Get the nth item (1-based), or null if there is no such item in the collection

If $n is negative, the nth item from the end of the collection is returned.


					
	public

pop(TValue|null &$last = null): static

Pop an item off the end of the collection

Parameters

$last

Receives the value removed from the collection, or null if the collection is empty.

Implemented by

Salient\Http\HttpHeaders::pop()


					
	public

shift(TValue|null &$first = null): static

Shift an item off the beginning of the collection

Parameters

$first

Receives the value removed from the collection, or null if the collection is empty.

Implemented by

Salient\Http\HttpHeaders::shift()

Methods inherited from ArrayAccess
`offsetExists(), offsetGet(), offsetSet(), offsetUnset()`

Methods inherited from Salient\Contract\Core\Arrayable
`toArray()`

Methods inherited from Countable
`count()`

Methods inherited from IteratorAggregate
`getIterator()`

Methods inherited from JsonSerializable
`jsonSerialize()`

Methods inherited from Salient\Contract\Core\Jsonable
`toJson()`

Constants
`public`	`CALLBACK_USE_VALUE = 1` Pass the value of each item to the callback Pass the value of each item to the callback	#
`public`	`CALLBACK_USE_KEY = 2` Pass the key of each item to the callback Pass the key of each item to the callback	#
`public`	`CALLBACK_USE_BOTH = 3` Pass a key-value pair to the callback for each item Pass a key-value pair to the callback for each item	#
`public`	`FIND_VALUE = 4` Return the first item that satisfies the callback Return the first item that satisfies the callback	#
`public`	`FIND_KEY = 8` Return the key of the first item that satisfies the callback Return the key of the first item that satisfies the callback	#

Namespaces

Interfaces

Interface Salient\Contract\Collection\CollectionInterface

`<TKey is array-key, TValue>`

Implemented by

Implemented by

Throws

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Implemented by

Parameters

Implemented by

Parameters

Implemented by