MutableMap
Represents a write-enabled (mutable) sequence of key/value pairs (i.e. a map)
Guides
Interface Synopsis
interface MutableMap implements ConstMap<Tk, Tv>, HH\Collection<Pair<Tk, Tv>>, MapAccess<Tk, Tv> {...}
Public Methods
->concat<Tu super Tv>(Traversable<Tu> $traversable): MutableVector<Tu>
Returns aMutableVector
that is the concatenation of the values of the currentMutableMap
and the values of the providedTraversable
->filter((function(Tv): bool) $fn): MutableMap<Tk, Tv>
Returns aMutableMap
containing the values of the currentMutableMap
that meet a supplied condition->filterWithKey((function(Tk, Tv): bool) $fn): MutableMap<Tk, Tv>
Returns aMutableMap
containing the values of the currentMutableMap
that meet a supplied condition applied to its keys and values->firstKey(): ?Tk
Returns the first key in the currentMutableMap
->firstValue(): ?Tv
Returns the first value in the currentMutableMap
->keys(): MutableVector<Tk>
Returns aMutableVector
containing the keys of the currentMutableMap
->lastKey(): ?Tk
Returns the last key in the currentMutableMap
->lastValue(): ?Tv
Returns the last value in the currentMutableMap
->map<Tu>((function(Tv): Tu) $fn): MutableMap<Tk, Tu>
Returns aMutableMap
after an operation has been applied to each value in the currentMutableMap
->mapWithKey<Tu>((function(Tk, Tv): Tu) $fn): MutableMap<Tk, Tu>
Returns aMutableMap
after an operation has been applied to each key and value in the currentMutableMap
->skip(int $n): MutableMap<Tk, Tv>
Returns aMutableMap
containing the values after then
-th element of the currentMutableMap
->skipWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
Returns aMutableMap
containing the values of the currentMutableMap
starting after and including the first value that producestrue
when passed to the specified callback->slice(int $start, int $len): MutableMap<Tk, Tv>
Returns a subset of the currentMutableMap
starting from a given key location up to, but not including, the element at the provided length from the starting key location->take(int $n): MutableMap<Tk, Tv>
Returns aMutableMap
containing the firstn
key/values of the currentMutableMap
->takeWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
Returns aMutableMap
containing the keys and values of the currentMutableMap
up to but not including the first value that producesfalse
when passed to the specified callback->toDArray(): darray<Tk, Tv>
->toVArray(): varray<Tv>
->values(): MutableVector<Tv>
Returns aMutableVector
containing the values of the currentMutableMap
->zip<Tu>(Traversable<Tu> $traversable): MutableMap<Tk, Pair<Tv, Tu>>
Returns aMutableMap
where each value is aPair
that combines the value of the currentMutableMap
and the providedTraversable
Public Methods (ConstCollection
)
-
->count(): int
Get the number of items in the collection -
->isEmpty(): bool
Is the collection empty? -
->items(): HH\Iterable<Te>
Get access to the items in the collection
Public Methods (IPureStringishObject
)
Public Methods (ConstSetAccess
)
->contains(arraykey $m): bool
Checks whether a value is in the currentSet
Public Methods (ConstIndexAccess
)
->at(Tk $k): Tv
Returns the value at the specified key in the current collection->containsKey(mixed $k): bool
Determines if the specified key is in the current collection->get(Tk $k): ?Tv
Returns the value at the specified key in the current collection
Public Methods (HH\KeyedIterable
)
->getIterator(): KeyedIterator<Tk, Tv>
Returns an iterator that points to beginning of the currentKeyedIterable
->lazy(): KeyedIterable<Tk, Tv>
Returns a lazy, access elements only when needed view of the currentKeyedIterable
->toImmMap(): ImmMap<Tk, Tv>
Returns an immutable map (ImmMap
) based on the keys and values of the currentKeyedIterable
->toKeysArray(): varray
Returns anarray
with the keys from the currentKeyedIterable
Public Methods (HH\Iterable
)
->toImmSet(): ImmSet<Tv>
Returns an immutable set (ImmSet
) converted from the currentIterable
->toImmVector(): ImmVector<Tv>
Returns an immutable vector (ImmVector
) converted from the currentIterable
->toValuesArray(): varray<Tv>
Returns anarray
with the values from the currentIterable
Public Methods (HH\Collection
)
->clear()
Removes all items from the collection
Public Methods (OutputCollection
)
->add(Te $e): this
Add a value to the collection and return the collection itself->addAll(?Traversable<Te> $traversable): this
For every element in the providedTraversable
, append a value into the current collection
Public Methods (SetAccess
)
->remove(Tm $m): this
Removes the provided value from the currentSet
Public Methods (IndexAccess
)
->removeKey(Tk $k): this
Removes the specified key (and associated value) from the current collection->set(Tk $k, Tv $v): this
Stores a value into the current collection with the specified key, overwriting the previous value associated with the key->setAll(?KeyedTraversable<Tk, Tv> $traversable): this
For every element in the providedTraversable
, stores a value into the current collection associated with each key, overwriting the previous value associated with the key