Map

A traversable object or an array to use for the initial values.

callback ( mixed \$key , mixed \$value ): mixed
A callable to apply to each value in the map. The callback should return what the value should be replaced by.

Returns a shallow copy of the map.

The custom count as an integer.

The return value is cast to an integer.

The result of removing all keys from the current instance that are present in a given map.

callback ( mixed \$key , mixed \$value ): bool
Optional callable which returns true if the pair should be included, false otherwise. If a callback is not provided, only values which are true (see converting to boolean) will be included.

A new map containing all the pairs for which either the callback returned true, or all values that convert to true if a callback was not provided.

The first pair in the map.

The key to look up.

The optional default value, returned if the key could not be found.

The value mapped to the given key, or the default value if provided and the key could not be found in the map.

An instance of an object implementing Iterator or Traversable

The key to look for.

The value to look for.

The key intersection of the current instance and another map.

data which can be serialized by json_encode, which is a value of any type other than a resource.

A Ds\Set containing all the keys of the map.

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int of the callback's return value. So values such as 0.99 and 0.1 will both be cast to an integer value of 0, which will compare such values as equal.

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int of the callback's return value. So values such as 0.99 and 0.1 will both be cast to an integer value of 0, which will compare such values as equal.

Returns a copy of the map, sorted by key.

The last pair of the map.

callback ( mixed \$key , mixed \$value ): mixed
A callable to apply to each value in the map. The callable should return what the key will be mapped to in the resulting map.

The result of applying a callback to each value in the map. The keys and values of the current instance won't be affected.

A traversable object or an array.

The result of associating all keys of a given traversable object or array with their corresponding values, combined with the current instance. The current instance won't be affected.

Ds\Sequence containing all the pairs of the map.

The key to associate the value with.

The value to be associated with the key.

callback ( mixed \$carry , mixed \$key , mixed \$value ): mixed
\$carry - The return value of the previous callback, or initial if it's the first iteration.
\$key - The key of the current iteration.
\$value - The value of the current iteration.

The initial value of the carry value. Can be null.

The return value of the final callback.

The key to remove.

The optional default value, returned if the key could not be found.

The value that was removed, or the default value if provided and the key could not be found in the map.

A reversed copy of the map. The current instance is not affected.

Returns the Ds\Pair at the given position.

A subset of the map defined by a starting index and length.

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int of the callback's return value. So values such as 0.99 and 0.1 will both be cast to an integer value of 0, which will compare such values as equal.

The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Returning non-integer values from the comparison function, such as float, will result in an internal cast to int of the callback's return value. So values such as 0.99 and 0.1 will both be cast to an integer value of 0, which will compare such values as equal.

Returns a copy of the map, sorted by value.

The sum of all the values in the map as either a float or int depending on the values in the map.

An array containing all the values in the same order as the map.

A new map containing all the pairs of the current instance as well as another map.

A Ds\Sequence containing all the values of the map.

A new map containing keys in the current instance as well as another map, but not in both.

An offset to check for.

true on success or false on failure.

The return value will be casted to boolean if non-boolean was returned.

The offset to retrieve.

Can return all value types.

The offset to assign the value to.

The value to set.

No value is returned.

The offset to unset.

No value is returned.