MutableMap

Represents a write-enabled (mutable) sequence of key/value pairs (i.e. a map)

Guides

• Introduction
• Interfaces

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 a MutableVector that is the concatenation of the values of the current MutableMap and the values of the provided Traversable
• ->filter((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap that meet a supplied condition
• ->filterWithKey((function(Tk, Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap that meet a supplied condition applied to its keys and values
• ->firstKey(): ?Tk
  Returns the first key in the current MutableMap
• ->firstValue(): ?Tv
  Returns the first value in the current MutableMap
• ->keys(): MutableVector<Tk>
  Returns a MutableVector containing the keys of the current MutableMap
• ->lastKey(): ?Tk
  Returns the last key in the current MutableMap
• ->lastValue(): ?Tv
  Returns the last value in the current MutableMap
• ->map<Tu>((function(Tv): Tu) $fn): MutableMap<Tk, Tu>
  Returns a MutableMap after an operation has been applied to each value in the current MutableMap
• ->mapWithKey<Tu>((function(Tk, Tv): Tu) $fn): MutableMap<Tk, Tu>
  Returns a MutableMap after an operation has been applied to each key and value in the current MutableMap
• ->skip(int $n): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values after the n-th element of the current MutableMap
• ->skipWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the values of the current MutableMap starting after and including the first value that produces true when passed to the specified callback
• ->slice(int $start, int $len): MutableMap<Tk, Tv>
  Returns a subset of the current MutableMap 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 a MutableMap containing the first n key/values of the current MutableMap
• ->takeWhile((function(Tv): bool) $fn): MutableMap<Tk, Tv>
  Returns a MutableMap containing the keys and values of the current MutableMap up to but not including the first value that produces false when passed to the specified callback
• ->toDArray(): darray<Tk, Tv>
• ->toVArray(): varray<Tv>
• ->values(): MutableVector<Tv>
  Returns a MutableVector containing the values of the current MutableMap
• ->zip<Tu>(Traversable<Tu> $traversable): MutableMap<Tk, Pair<Tv, Tu>>
  Returns a MutableMap where each value is a Pair that combines the value of the current MutableMap and the provided Traversable