PHPackages aimeos/map - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. aimeos/map ActiveLibrary[Utility & Helpers](/categories/utility) aimeos/map ========== Easy and elegant handling of PHP arrays as array-like collection objects similar to jQuery and Laravel Collections 3.14.0(1mo ago)4.2k412.9k↑28.8%16[1 issues](https://github.com/aimeos/map/issues)8MITPHPPHP ^7.1||^8.0CI passing Since Nov 27Pushed 2mo ago8 watchersCompare [ Source](https://github.com/aimeos/map)[ Packagist](https://packagist.org/packages/aimeos/map)[ RSS](/packages/aimeos-map/feed)WikiDiscussions 3.x Synced 1mo ago READMEChangelogDependencies (6)Versions (49)Used By (8) [![Build Status](https://github.com/aimeos/map/actions/workflows/php.yml/badge.svg)](https://github.com/aimeos/map/actions)[![Coverage Status](https://camo.githubusercontent.com/b93681334d2105fdd66e88fa7396447162ef81e5251e5051cf3fee70013ca226/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f61696d656f732f6d61702f62616467652e737667)](https://coveralls.io/github/aimeos/map)[![License](https://camo.githubusercontent.com/8873c01142ecfc1e9e6c2353d2237e6d36cc12d712abeeb8202d65ccc7615e59/68747470733a2f2f706f7365722e707567782e6f72672f61696d656f732f6d61702f6c6963656e73652e737667)](https://packagist.org/packages/aimeos/map)[![Latest Stable Version](https://camo.githubusercontent.com/ebe6e85e8c2b86dace72d6ca9cd54eedebf528fabd710e9bf0881887f12356b3/68747470733a2f2f706f7365722e707567782e6f72672f61696d656f732f6d61702f762f737461626c65)](https://packagist.org/packages/aimeos/map)[![Stars](https://camo.githubusercontent.com/47cc9c8cdf953893f2dec03f7f39acda42cd4a7c932c4aa760a2053a64d7562d/68747470733a2f2f62616467656e2e6e65742f6769746875622f73746172732f61696d656f732f6d6170)](https://packagist.org/packages/aimeos/map)[![Downloads](https://camo.githubusercontent.com/d006ccdde72ad35c0e8be783fae3dd8c355a6cee053f4a9f3cb60a5ecee44fc8/68747470733a2f2f706f7365722e707567782e6f72672f61696d656f732f6d61702f646f776e6c6f616473)](https://packagist.org/packages/aimeos/map) PHP arrays and collections made easy ==================================== [](#php-arrays-and-collections-made-easy) Easy and elegant handling of PHP arrays by using an array-like collection object as offered by jQuery and Laravel Collections. ``` composer req aimeos/map ``` Supported PHP versions: - PHP 7.1+ - PHP 8+ **Table of contents** - [Why PHP Map](#why-php-map) - [List of methods](#methods) - [Create](#create) - [Access](#access) - [Add](#add) - [Aggregate](#aggregate) - [Debug](#debug) - [Order](#order-by) - [Shorten](#shorten) - [Test](#test) - [Mutate](#mutate) - [Misc](#misc) - [Documentation](#method-documentation) - [Custom methods](#custom-methods) - [Performance](#performance) - [Upgrade guide](#upgrade-guide) Why PHP Map ----------- [](#why-php-map) **Instead of:** ``` $list = [['id' => 'one', 'value' => 'value1'], ['id' => 'two', 'value' => 'value2'], null]; $list[] = ['id' => 'three', 'value' => 'value3']; // add element unset( $list[0] ); // remove element $list = array_filter( $list ); // remove empty values sort( $list ); // sort elements $pairs = array_column( $list, 'value', 'id' ); // create ['three' => 'value3'] $value = reset( $pairs ) ?: null; // return first value ``` **Only use:** ``` $list = [['id' => 'one', 'value' => 'value1'], ['id' => 'two', 'value' => 'value2'], null]; $value = map( $list ) // create Map ->push( ['id' => 'three', 'value' => 'value3'] ) // add element ->remove( 0 ) // remove element ->filter() // remove empty values ->sort() // sort elements ->col( 'value', 'id' ) // create ['three' => 'value3'] ->first(); // return first value ``` **You can still use:** ``` $map[] = ['id' => 'three', 'value' => 'value3']; $value = $map[0]; count( $map ); foreach( $map as $key => value ); ``` **Use callbacks:** Also, the map object allows you to pass anonymous functions to a lot of methods, e.g.: ``` $map->each( function( $val, $key ) { echo $key . ': ' . $val; } ); ``` **jQuery style:** If your map elements are objects, you can call their methods for each object and get the result as new map just like in jQuery: ``` // MyClass implements setStatus() (returning $this) and getCode() (initialized by constructor) $map = Map::from( ['a' => new MyClass( 'x' ), 'b' => new MyClass( 'y' )] ); $map->setStatus( 1 )->getCode()->toArray(); ``` This will call `setStatus( 1 )` on both objects. If `setStatus()` implementation returns `$this`, the new map will also contain: ``` ['a' => MyClass(), 'b' => MyClass()] ``` On those new map elements, `getCode()` will be called which returns `x` for the first object and `y` for the second. The map created from the results of `getCode()`will return: ``` ['a' => 'x', 'b' => 'y'] ``` Methods ------- [](#methods) [function is\_map](#is_map-function)[function map](#map-function)[\_\_construct](#__construct)[\_\_call](#__call)[\_\_callStatic](#__callstatic)[after](#after)[all](#all)[any](#any)[arsort](#arsort)[arsorted](#arsorted)[asort](#asort)[asorted](#asorted)[at](#at)[avg](#avg)[before](#before)[bool](#bool)[call](#call)[cast](#cast)[chunk](#chunk)[clear](#clear)[clone](#clone)[col](#col)[collapse](#collapse)[combine](#combine)[concat](#concat)[contains](#contains)[copy](#copy)[count](#count)[countBy](#countby)[dd](#dd)[delimiter](#delimiter)[diff](#diff)[diffAssoc](#diffassoc)[diffKeys](#diffkeys)[dump](#dump)[duplicates](#duplicates)[each](#each)[empty](#empty)[equals](#equals)[every](#every)[except](#except)[explode](#explode)[fill](#fill)[filter](#filter)[find](#find)[findKey](#findkey)[first](#first)[firstKey](#firstkey)[flat](#flat)[flatten](#flatten)[flip](#flip)[float](#float)[from](#from)[fromJson](#fromjson)[get](#get)[getIterator](#getiterator)[grep](#grep)[groupBy](#groupby)[has](#has)[if](#if)[ifAny](#ifany)[ifEmpty](#ifempty)[implements](#implements)[in](#in)[includes](#includes)[index](#index)[insertAfter](#insertafter)[insertAt](#insertat)[insertBefore](#insertbefore)[int](#int)[intersect](#intersect)[intersectAssoc](#intersectassoc)[intersectKeys](#intersectkeys)[is](#is)[isEmpty](#isempty)[isList](#islist)[isObject](#isobject)[isNumeric](#isnumeric)[isScalar](#isscalar)[isSole](#issole)[isString](#isstring)[join](#join)[jsonSerialize](#jsonserialize)[keys](#keys)[krsort](#krsort)[krsorted](#krsorted)[ksort](#ksort)[ksorted](#ksorted)[last](#last)[lastKey](#lastkey)[ltrim](#ltrim)[map](#map)[max](#max)[merge](#merge)[method](#method)[min](#min)[none](#none)[nth](#nth)[offsetExists](#offsetexists)[offsetGet](#offsetget)[offsetSet](#offsetset)[offsetUnset](#offsetunset)[only](#only)[order](#order)[pad](#pad)[partition](#partition)[percentage](#percentage)[pipe](#pipe)[pluck](#pluck)[pop](#pop)[pos](#pos)[prefix](#prefix)[prepend](#prepend)[pull](#pull)[push](#push)[put](#put)[random](#random)[reduce](#reduce)[reject](#reject)[rekey](#rekey)[remove](#remove)[replace](#replace)[restrict](#restrict)[reverse](#reverse)[reversed](#reversed)[rsort](#rsort)[rsorted](#rsorted)[rtrim](#rtrim)[search](#search)[sep](#sep)[set](#set)[shift](#shift)[shuffle](#shuffle)[shuffled](#shuffled)[skip](#skip)[slice](#slice)[sliding](#sliding)[sole](#sole)[some](#some)[sort](#sort)[sorted](#sorted)[splice](#splice)[strAfter](#strafter)[strBefore](#strbefore)[strCompare](#strcompare)[strContains](#strcontains)[strContainsAll](#strcontainsall)[strEnds](#strends)[strEndsAll](#strendsall)[string](#string)[strLower](#strlower)[strReplace](#strreplace)[strStarts](#strstarts)[strStartsAll](#strstartsall)[strUpper](#strupper)[suffix](#suffix)[sum](#sum)[take](#take)[tap](#tap)[times](#times)[to](#to)[toArray](#toarray)[toJson](#tojson)[toReversed](#toreversed)[toSorted](#tosorted)[toUrl](#tourl)[transform](#transform)[transpose](#transpose)[traverse](#traverse)[tree](#tree)[trim](#trim)[uasort](#uasort)[uasorted](#uasorted)[uksort](#uksort)[uksorted](#uksorted)[unflatten](#unflatten)[union](#union)[unique](#unique)[unshift](#unshift)[usort](#usort)[usorted](#usorted)[values](#values)[walk](#walk)[where](#where)[with](#with)[zip](#zip) ### Create [](#create) - [function map()](#map-function) : Creates a new map from passed elements - [\_\_construct()](#__construct) : Creates a new map - [clone()](#clone) : Clones the map and all objects within - [copy()](#copy) : Creates a new copy - [explode()](#explode) : Splits a string into a map of elements - [fill()](#fill) : Creates a new map filled with given value - [from()](#from) : Creates a new map from passed elements - [fromJson()](#fromjson) : Creates a new map from a JSON string - [times()](#times) : Creates a new map by invoking the closure a number of times - [tree()](#tree) : Creates a tree structure from the list items ### Access [](#access) - [\_\_call()](#__call) : Calls a custom method - [\_\_callStatic()](#__callstatic) : Calls a custom method statically - [all()](#all) : Returns the plain array - [any()](#any) : Tests if at least one element satisfies the callback function - [at()](#at) : Returns the value at the given position - [bool()](#bool) : Returns an element by key and casts it to boolean - [call()](#call) : Calls the given method on all items - [find()](#find) : Returns the first/last element where the callback returns TRUE - [findKey()](#findkey) : Returns the first/last key where the callback returns TRUE - [first()](#first) : Returns the first element - [firstKey()](#firstkey) : Returns the first key - [get()](#get) : Returns an element by key - [index()](#index) : Returns the numerical index of the given key - [int()](#int) : Returns an element by key and casts it to integer - [float()](#float) : Returns an element by key and casts it to float - [keys()](#keys) : Returns all keys - [last()](#last) : Returns the last element - [lastKey()](#lastkey) : Returns the last key - [pop()](#pop) : Returns and removes the last element - [pos()](#pos) : Returns the numerical index of the value - [pull()](#pull) : Returns and removes an element by key - [random()](#random) : Returns random elements preserving keys - [search()](#search) : Find the key of an element - [shift()](#shift) : Returns and removes the first element - [sole()](#sole) : Returns the matching item if it's the only one - [string()](#string) : Returns an element by key and casts it to string - [to()](#to) : Returns the plain array - [toArray()](#toarray) : Returns the plain array - [values()](#values) : Returns all elements with new keys ### Add [](#add) - [concat()](#concat) : Adds all elements with new keys - [insertAfter()](#insertafter) : Inserts the value after the given element - [insertAt()](#insertat) : Inserts the element at the given position in the map - [insertBefore()](#insertbefore) : Inserts the value before the given element - [merge()](#merge) : Combines elements overwriting existing ones - [pad()](#pad) : Fill up to the specified length with the given value - [prepend()](#prepend) : Adds an element at the beginning (alias) - [push()](#push) : Adds an element to the end - [put()](#put) : Sets the given key and value in the map (alias) - [set()](#set) : Overwrites or adds an element - [union()](#union) : Adds the elements without overwriting existing ones - [unshift()](#unshift) : Adds an element at the beginning - [with()](#with) : Returns a copy and sets an element ### Aggregate [](#aggregate) - [avg()](#avg) : Returns the average of all values - [count()](#count) : Returns the total number of elements - [countBy()](#countby) : Counts how often the same values are in the map - [max()](#max) : Returns the maximum value of all elements - [min()](#min) : Returns the minium value of all elements - [percentage()](#percentage) : Returns the percentage of all elements passing the test - [sum()](#sum) : Returns the sum of all values in the map ### Debug [](#debug) - [dd()](#dd) : Prints the map content and terminates the script - [dump()](#dump) : Prints the map content - [tap()](#tap) : Passes a clone of the map to the given callback ### Order By [](#order-by) - [arsort()](#arsort) : Reverse sort elements preserving keys - [arsorted()](#arsorted) : Reverse sort elements preserving keys in a copy of the map - [asort()](#asort) : Sort elements preserving keys - [asorted()](#asorted) : Sort elements preserving keys in a copy of the map - [krsort()](#krsort) : Reverse sort elements by keys - [krsorted()](#krsorted) : Reverse sort elements by keys in a copy of the map - [ksort()](#ksort) : Sort elements by keys - [ksorted()](#ksorted) : Sorts a copy of the elements by their keys - [order()](#order) : Orders elements by the passed keys - [reverse()](#reverse) : Reverses the array order preserving keys - [reversed()](#reversed) : Reverses the element order in a copy of the map - [toReversed()](#toreversed) : Reverses the element order in a copy of the map (alias) - [rsort()](#rsort) : Reverse sort elements using new keys - [rsorted()](#rsorted) : Reverse sort elements using new keys in a copy of the map - [shuffle()](#shuffle) : Randomizes the element order - [shuffled()](#shuffled) : Randomizes the element order in a copy of the map - [sort()](#sort) : Sorts the elements in-place assigning new keys - [sorted()](#sorted) : Sorts the elements in a copy of the map using new keys - [toSorted()](#tosorted) : Sorts the elements in a copy of the map using new keys (alias) - [uasort()](#uasort) : Sorts elements preserving keys using callback - [uasorted()](#uasorted) : Sorts elements preserving keys using callback in a copy of the map - [uksort()](#uksort) : Sorts elements by keys using callback - [uksorted()](#uksorted) : Sorts elements by keys using callback in a copy of the map - [usort()](#usort) : Sorts elements using callback assigning new keys - [usorted()](#usorted) : Sorts elements using callback assigning new keys in a copy of the map ### Shorten [](#shorten) - [after()](#after) : Returns the elements after the given one - [before()](#before) : Returns the elements before the given one - [clear()](#clear) : Removes all elements - [diff()](#diff) : Returns the elements missing in the given list - [diffAssoc()](#diffassoc) : Returns the elements missing in the given list and checks keys - [diffKeys()](#diffkeys) : Returns the elements missing in the given list by keys - [duplicates()](#duplicates) : Returns the duplicate values from the map - [except()](#except) : Returns a new map without the passed element keys - [filter()](#filter) : Applies a filter to all elements - [grep()](#grep) : Applies a regular expression to all elements - [intersect()](#intersect) : Returns the elements shared - [intersectAssoc()](#intersectassoc) : Returns the elements shared and checks keys - [intersectKeys()](#intersectkeys) : Returns the elements shared by keys - [nth()](#nth) : Returns every nth element from the map - [only()](#only) : Returns only those elements specified by the keys - [pop()](#pop) : Returns and removes the last element - [pull()](#pull) : Returns and removes an element by key - [reject()](#reject) : Removes all matched elements - [remove()](#remove) : Removes an element by key - [restrict()](#restrict) : Returns only the items matching the value (and key) - [shift()](#shift) : Returns and removes the first element - [skip()](#skip) : Skips the given number of items and return the rest - [slice()](#slice) : Returns a slice of the map - [take()](#take) : Returns a new map with the given number of items - [unique()](#unique) : Returns all unique elements preserving keys - [where()](#where) : Filters the list of elements by a given condition ### Test [](#test) - [function is\_map()](#is_map-function) : Tests if the variable is a map object - [any()](#any) : Tests if at least one element satisfies the callback function - [contains()](#contains) : Tests if an item exists in the map - [each()](#each) : Applies a callback to each element - [empty()](#empty) : Tests if map is empty - [equals()](#equals) : Tests if map contents are equal - [every()](#every) : Verifies that all elements pass the test of the given callback - [has()](#has) : Tests if a key exists - [if()](#if) : Executes callbacks depending on the condition - [ifAny()](#ifany) : Executes callbacks if the map contains elements - [ifEmpty()](#ifempty) : Executes callbacks if the map is empty - [in()](#in) : Tests if element is included - [includes()](#includes) : Tests if element is included - [is()](#is) : Tests if the map consists of the same keys and values - [isEmpty()](#isempty) : Tests if map is empty - [isList()](#islist) : Checks if the map contains a list of subsequentially numbered keys - [isNumeric()](#isnumeric) : Tests if all entries are numeric values - [isObject()](#isobject) : Tests if all entries are objects - [isScalar()](#isscalar) : Tests if all entries are scalar values. - [isSole()](#issole) : Returns only true if exactly one item is matching. - [isString()](#isstring) : Tests if all entries are string values. - [implements()](#implements) : Tests if all entries are objects implementing the interface - [none()](#none) : Tests if none of the elements are part of the map - [some()](#some) : Tests if at least one element is included - [strCompare()](#strcompare) : Compares the value against all map elements - [strContains()](#strcontains) : Tests if at least one of the passed strings is part of at least one entry - [strContainsAll()](#strcontainsall) : Tests if all of the entries contains one of the passed strings - [strEnds()](#strends) : Tests if at least one of the entries ends with one of the passed strings - [strEndsAll()](#strendsall) : Tests if all of the entries ends with at least one of the passed strings - [strStarts()](#strstarts) : Tests if at least one of the entries starts with at least one of the passed strings - [strStartsAll()](#strstartsall) : Tests if all of the entries starts with one of the passed strings ### Mutate [](#mutate) - [cast()](#cast) : Casts all entries to the passed type - [chunk()](#chunk) : Splits the map into chunks - [col()](#col) : Creates a key/value mapping - [collapse()](#collapse) : Collapses multi-dimensional elements overwriting elements - [combine()](#combine) : Combines the map elements as keys with the given values - [flat()](#flat) : Flattens multi-dimensional elements without overwriting elements - [flatten()](#flatten) : Creates a new map with keys joined recursively - [flip()](#flip) : Exchanges keys with their values - [groupBy()](#groupby) : Groups associative array elements or objects - [join()](#join) : Returns concatenated elements as string with separator - [ltrim()](#ltrim) : Removes the passed characters from the left of all strings - [map()](#map) : Applies a callback to each element and returns the results - [partition()](#partition) : Breaks the list into the given number of groups - [pipe()](#pipe) : Applies a callback to the whole map - [pluck()](#pluck) : Creates a key/value mapping (alias) - [prefix()](#prefix) : Adds a prefix to each map entry - [reduce()](#reduce) : Computes a single value from the map content - [rekey()](#rekey) : Changes the keys according to the passed function - [replace()](#replace) : Replaces elements recursively - [rtrim()](#rtrim) : Removes the passed characters from the right of all strings - [sliding()](#sliding) : Returns a new map containing sliding windows of the original map - [splice()](#splice) : Replaces a slice by new elements - [strAfter()](#strafter) : Returns the strings after the passed value - [strBefore()](#strbefore) : Returns the strings before the passed value - [strLower()](#strlower) : Converts all alphabetic characters to lower case - [strReplace()](#strreplace) : Replaces all occurrences of the search string with the replacement string - [strUpper()](#strupper) : Converts all alphabetic characters to upper case - [suffix()](#suffix) : Adds a suffix to each map entry - [toJson()](#tojson) : Returns the elements in JSON format - [toUrl()](#tourl) : Creates a HTTP query string - [transform()](#transform) : Applies a callback to each element which creates new key/value pairs - [transpose()](#transpose) : Exchanges rows and columns for a two dimensional map - [traverse()](#traverse) : Traverses trees of nested items passing each item to the callback - [trim()](#trim) : Removes the passed characters from the left/right of all strings - [unflatten()](#unflatten) : Unflattens the key path/value pairs into a multi-dimensional array - [walk()](#walk) : Applies the given callback to all elements - [zip()](#zip) : Merges the values of all arrays at the corresponding index ### Misc [](#misc) - [delimiter()](#delimiter) : Sets or returns the seperator for paths to multi-dimensional arrays - [getIterator()](#getiterator) : Returns an iterator for the elements - [jsonSerialize()](#jsonserialize) : Specifies the data which should be serialized to JSON - [method()](#method) : Registers a custom method - [offsetExists()](#offsetexists) : Checks if the key exists - [offsetGet()](#offsetget) : Returns an element by key - [offsetSet()](#offsetset) : Overwrites an element - [offsetUnset()](#offsetunset) : Removes an element by key - [sep()](#sep) : Sets the seperator for paths to multi-dimensional arrays in the current map Method documentation -------------------- [](#method-documentation) ### is\_map() function [](#is_map-function) Tests if the variable is a map object ``` function is_map( $var ) : bool ``` - @param **mixed** `$var` Variable to test **Examples:** ``` is_map( new Map() ); // true is_map( [] ); // false ``` ### map() function [](#map-function) Returns a new map for the passed elements. ``` function map( $elements = [] ) : \Aimeos\Map ``` - @param **mixed** `$elements` List of elements or single value - @return **\\Aimeos\\Map** Map instance **Examples:** ``` // array map( [] ); // null map( null ); // scalar map( 'a' ); // object map( new \stdClass() ); // map object map( new Map() ); // iterable object map( new ArrayObject() ); // closure evaluated lazily map( function() { return []; } ); ``` **See also:** - [rekey()](#rekey) - Changes the keys according to the passed function - [transform()](#transform) - Creates new key/value pairs using the passed function and returns a new map for the result ### \_\_construct() [](#__construct) Creates a new map object. ``` public function __construct( $elements = [] ) ``` - @param **mixed** `$elements` Single element, list of elements, Map object, iterable objects or iterators, everything else **Examples:** ``` // array new Map( [] ); // null new Map( null ); // scalar new Map( 'a' ); // object new Map( new \stdClass() ); // map object new Map( new Map() ); // iterable object new Map( new ArrayObject() ); // closure evaluated lazily new Map( function() { return []; } ); ``` ### \_\_call() [](#__call) Handles dynamic calls to custom methods for the class. ``` public function __call( string $name, array $params ) ``` - @param **string** `$name` Method name - @param **array<mixed>** `$params` List of parameters - @return **mixed** Result from called function or new map with results from the element methods Calls a custom method added by [Map::method()](#method). The called method has access to the internal array by using `$this->items`. **Examples:** ``` Map::method( 'case', function( $case = CASE_LOWER ) { return new self( array_change_key_case( $this->items, $case ) ); } ); Map::from( ['a' => 'bar'] )->case( CASE_UPPER ); // ['A' => 'bar'] ``` This does also allow calling object methods if the items are objects: ``` $item = new MyClass(); // with method setStatus() (returning $this) and getCode() implemented Map::from( [$item, $item] )->setStatus( 1 )->getCode()->toArray(); ``` This will call the `setStatus()` method of each element in the map and use their return values to create a new map. On the new map, the `getCode()`method is called for every element and its return values are also stored in a new map. This last map is then returned and the map keys from the original map are preserved in the returned map. If the elements are not objects, they are skipped and if this applies to all elements, an empty map is returned. In case the map contains objects of mixed types and one of them doesn't implement the called method, an error will be thrown. **See also:** - [\_\_callStatic()](#__callStatic) - Handles static calls to custom methods for the class - [call()](#call) - Calls the given method on all items and returns the result ### \_\_callStatic() [](#__callstatic) Handles static calls to custom methods for the class. ``` public static function __callStatic( string $name, array $params ) ``` - @param **string** `$name` Method name - @param **array<mixed>** `$params` List of parameters - @return **mixed** Result from called function or new map with results from the element methods - @throws **\\BadMethodCallException** If no method has been registered for that name Calls a custom method added by [Map::method()](#method) statically. The called method has no access to the internal array because no object is available. **Examples:** ``` Map::method( 'foo', function( $arg1, $arg2 ) {} ); Map::foo( $arg1, $arg2 ); ``` **See also:** - [\_\_call()](#__call) - Handles dynamic calls to custom methods for the class - [call()](#call) - Calls the given method on all items and returns the result ### after() [](#after) Returns the elements after the given one. ``` public function after( $value ) : self ``` - @param **\\Closure|int|string** `$value` Value or function with (item, key) parameters - @return **self<int|string,mixed>** New map with the elements after the given one The keys are preserved using this method. **Examples:** ``` Map::from( [0 => 'b', 1 => 'a'] )->after( 'b' ); // [1 => 'a'] Map::from( ['a' => 1, 'b' => 0] )->after( 1 ); // ['b' => 0] Map::from( [0 => 'b', 1 => 'a'] )->after( 'c' ); // [] Map::from( ['a', 'c', 'b'] )->after( function( $item, $key ) { return $item >= 'c'; } ); // [2 => 'b'] ``` **See also:** - [before()](#before) - Returns the elements before the given one ### all() [](#all) Returns the elements as a plain array. ``` public function all() : array ``` - @return **array** Plain array **Examples:** ``` Map::from( ['a'] )->all(); // ['a'] ``` This method is for compatibility to Laravel Collections. Use [`to()`](#to) instead if possible. **See also:** - [to()](#to) - Returns the elements as a plain array - [toArray()](#toarray) - Returns the elements as a plain array ### any() [](#any) Tests if at least one element satisfies the callback function. ``` public function any( \Closure $callback ) : bool ``` - @param \\Closure $callback Anonymous function with (item, key) parameter - @return bool TRUE if at least one element satisfies the callback function, FALSE if not **Examples:** ``` Map::from( ['a', 'b'] )->any( function( $item, $key ) { return $item === 'a'; } ); // TRUE Map::from( ['a', 'b'] )->any( function( $item, $key ) { return !is_string( $item ); } ); // FALSE ``` **See also:** - [some()](#some) - Tests if at least one element passes the test or is part of the map - [every()](#every) - Verifies that all elements pass the test of the given callback ### arsort() [](#arsort) Sorts all elements in reverse order and maintains the key association. ``` public function arsort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `arsort()` - @return **self<int|string,mixed>** Updated map for fluid interface The keys are preserved using this method and no new map is created. The `$options` parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->arsort(); // ['a' => 1, 'b' => 0] Map::from( ['a', 'b'] )->arsort(); // ['b', 'a'] Map::from( [0 => 'C', 1 => 'b'] )->arsort(); // [1 => 'b', 0 => 'C'] Map::from( [0 => 'C', 1 => 'b'] )->arsort( SORT_STRING|SORT_FLAG_CASE ); // [0 => 'C', 1 => 'b'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [arsorted()](#arsorted) - Sorts a copy of all elements in reverse order and maintains the key association ### arsorted() [](#arsorted) Sorts a copy of all elements in reverse order and maintains the key association. ``` public function arsorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `arsort()` - @return **self<int|string,mixed>** New map The keys are preserved using this method and a new map is created. The `$options` parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->arsorted(); // ['a' => 1, 'b' => 0] Map::from( ['a', 'b'] )->arsorted(); // ['b', 'a'] Map::from( [0 => 'C', 1 => 'b'] )->arsorted(); // [1 => 'b', 0 => 'C'] Map::from( [0 => 'C', 1 => 'b'] )->arsorted( SORT_STRING|SORT_FLAG_CASE ); // [0 => 'C', 1 => 'b'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [arsort()](#arsort) - Sorts all elements in reverse order and maintains the key association ### asort() [](#asort) Sorts all elements and maintains the key association. ``` public function asort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `asort()` - @return **self<int|string,mixed>** Updated map for fluid interface The keys are preserved using this method and no new map is created. The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->asort(); // ['b' => 0, 'a' => 1] Map::from( [0 => 'b', 1 => 'a'] )->asort(); // [1 => 'a', 0 => 'b'] Map::from( [0 => 'C', 1 => 'b'] )->asort(); // [0 => 'C', 1 => 'b'] because 'C' < 'b' Map::from( [0 => 'C', 1 => 'b'] )->asort( SORT_STRING|SORT_FLAG_CASE ); // [1 => 'b', 0 => 'C'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [asorted()](#asorted) - Sorts a copy of all elements and maintains the key association ### asorted() [](#asorted) Sorts a copy of all elements and maintains the key association. ``` public function asorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `asort()` - @return **self<int|string,mixed>** New map The keys are preserved using this method and a new map is created. The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->asorted(); // ['b' => 0, 'a' => 1] Map::from( [0 => 'b', 1 => 'a'] )->asorted(); // [1 => 'a', 0 => 'b'] Map::from( [0 => 'C', 1 => 'b'] )->asorted(); // [0 => 'C', 1 => 'b'] because 'C' < 'b' Map::from( [0 => 'C', 1 => 'b'] )->asorted( SORT_STRING|SORT_FLAG_CASE ); // [1 => 'b', 0 => 'C'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [asort()](#asort) - Sorts all elements and maintains the key association ### at() [](#at) Returns the value at the given position. ``` public function at( int $pos ) ``` - @param **int** `$pos` Position of the value in the map - @return **mixed�null** Value at the given position or NULL if no value is available The position starts from zero and a position of "0" returns the first element of the map, "1" the second and so on. If the position is negative, the sequence will start from the end of the map. **Examples:** ``` Map::from( [1, 3, 5] )->at( 0 ); // 1 Map::from( [1, 3, 5] )->at( 1 ); // 3 Map::from( [1, 3, 5] )->at( -1 ); // 5 Map::from( [1, 3, 5] )->at( 3 ); // NULL ``` **See also:** - [index()](#index) - Returns the numerical index of the given key - [pos()](#pos) - Returns the numerical index of the value ### avg() [](#avg) Returns the average of all integer and float values in the map. ``` public function avg( $col = null ) : float ``` - @param **Closure|string|null** `$col` Closure, key or path to the values in the nested array or object to compute the average for - @return **float** Average of all elements or 0 if there are no elements in the map Non-numeric values will be removed before calculation. This does also work for multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. "key1/key2/key3" to get "val" from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( [1, 3, 5] )->avg(); // 3 Map::from( [1, null, 5] )->avg(); // 3 Map::from( [1, 'sum', 5] )->avg(); // 2 Map::from( [['p' => 30], ['p' => 50], ['p' => 10]] )->avg( 'p' ); // 30 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->avg( 'i/p' ); // 40 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->avg( fn( $val, $key ) => $val['i']['p'] ?? null ); // 40 Map::from( [['p' => 30], ['p' => 50], ['p' => 10]] )->avg( fn( $val, $key ) => $key < 1 ? $val : null ); // 30 ``` **See also:** - [count()](#count) - Returns the total number of elements - [max()](#max) - Returns the maximum value of all elements - [min()](#min) - Returns the minium value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test - [sum()](#sum) - Returns the sum of all values in the map ### before() [](#before) Returns the elements before the given one. ``` public function before( $value ) : self ``` - @param **\\Closure|int|string** `$value` Value or function with (item, key) parameters - @return **self<int|string,mixed>** New map with the elements before the given one The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->before( 0 ); // ['a' => 1] Map::from( [0 => 'b', 1 => 'a'] )->before( 'a' ); // [0 => 'b'] Map::from( [0 => 'b', 1 => 'a'] )->before( 'c' ); // [] Map::from( ['a', 'c', 'b'] )->before( function( $item, $key ) { return $key >= 1; } ); // [0 => 'a'] ``` **See also:** - [after()](#after) - Returns the elements after the given one ### bool() [](#bool) Returns an element by key and casts it to boolean if possible. ``` public function bool( $key, $default = false ) : bool ``` - @param **int|string** `$key` Key or path to the requested item - @param **mixed** `$default` Default value if key isn't found (will be casted to bool) - @return **bool** Value from map or default value This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => true] )->bool( 'a' ); // true Map::from( ['a' => '1'] )->bool( 'a' ); // true (casted to boolean) Map::from( ['a' => 1.1] )->bool( 'a' ); // true (casted to boolean) Map::from( ['a' => '10'] )->bool( 'a' ); // true (casted to boolean) Map::from( ['a' => 'abc'] )->bool( 'a' ); // true (casted to boolean) Map::from( ['a' => ['b' => ['c' => true]]] )->bool( 'a/b/c' ); // true Map::from( [] )->bool( 'c', function() { return rand( 1, 2 ); } ); // true (value returned by closure is casted to boolean) Map::from( [] )->bool( 'a', true ); // true (default value used) Map::from( [] )->bool( 'a' ); // false Map::from( ['b' => ''] )->bool( 'b' ); // false (casted to boolean) Map::from( ['b' => null] )->bool( 'b' ); // false (null is not scalar) Map::from( ['b' => [true]] )->bool( 'b' ); // false (arrays are not scalar) Map::from( ['b' => '#resource'] )->bool( 'b' ); // false (resources are not scalar) Map::from( ['b' => new \stdClass] )->bool( 'b' ); // false (objects are not scalar) Map::from( [] )->bool( 'c', new \Exception( 'error' ) ); // throws exception ``` **See also:** - [cast()](#cast) - Casts all entries to the passed type - [float()](#float) - Returns an element by key and casts it to float if possible - [get()](#get) - Returns an element from the map by key - [int()](#int) - Returns an element by key and casts it to integer if possible - [string()](#string) - Returns an element by key and casts it to string if possible ### call() [](#call) Calls the given method on all items and returns the result. ``` public function call( string $name, array $params = [] ) : self ``` - @param **string** `$name` Method name - @param **array<mixed>** `$params` List of parameters - @return **self<int|string,mixed>** New map with results from all elements This method can call methods on the map entries that are also implemented by the map object itself and are therefore not reachable when using the magic `__call()` method. If some entries are not objects, they will be skipped. The keys from the original map are preserved in the returned in the new map. **Examples:** ``` $item = new MyClass( ['myprop' => 'val'] ); // implements methods get() and toArray() Map::from( [$item, $item] )->call( 'get', ['myprop'] ); // ['val', 'val'] Map::from( [$item, $item] )->call( 'toArray' ); // [['myprop' => 'val'], ['myprop' => 'val']] ``` **See also:** - [\_\_call()](#__call) - Handles dynamic calls to custom methods for the class - [\_\_callStatic()](#__callStatic) - Handles static calls to custom methods for the class ### cast() [](#cast) Casts all entries to the passed type. ``` public function cast( string $type = 'string' ) : self ``` - @param **string** `$type` Type to cast the values to ("string", "bool", "int", "float", "array", "object") - @return **self<int|string,mixed>** Updated map with casted elements Casting arrays and objects to scalar values won't return anything useful! **Examples:** ``` Map::from( [true, 1, 1.0, 'yes'] )->cast(); // ['1', '1', '1.0', 'yes'] Map::from( [true, 1, 1.0, 'yes'] )->cast( 'bool' ); // [true, true, true, true] Map::from( [true, 1, 1.0, 'yes'] )->cast( 'int' ); // [1, 1, 1, 0] Map::from( [true, 1, 1.0, 'yes'] )->cast( 'float' ); // [1.0, 1.0, 1.0, 0.0] Map::from( [new stdClass, new stdClass] )->cast( 'array' ); // [[], []] Map::from( [[], []] )->cast( 'object' ); // [new stdClass, new stdClass] ``` **See also:** - [bool()](#bool) - Returns an element by key and casts it to boolean if possible - [int()](#int) - Returns an element by key and casts it to integer if possible - [float()](#float) - Returns an element by key and casts it to float if possible - [string()](#string) - Returns an element by key and casts it to string if possible ### chunk() [](#chunk) Chunks the map into arrays with the given number of elements. ``` public function chunk( int $size, bool $preserve = false ) : self ``` - @param **int** `$size` Maximum size of the sub-arrays - @param **bool** `$preserve` Preserve keys in new map - @return **self<int|string,mixed>** New map with elements chunked in sub-arrays - @throws **\\InvalidArgumentException** If size is smaller than 1 The last chunk may contain less elements than the given number. The sub-arrays of the returned map are plain PHP arrays. If you need Map objects, then wrap them with [Map::from()](#from) when you iterate over the map. **Examples:** ``` Map::from( [0, 1, 2, 3, 4] )->chunk( 3 ); // [[0, 1, 2], [3, 4]] Map::from( ['a' => 0, 'b' => 1, 'c' => 2] )->chunk( 2 ); // [['a' => 0, 'b' => 1], ['c' => 2]] ``` **See also:** - [partition()](#partition) - Breaks the list into the given number of groups ### clear() [](#clear) Removes all elements from the current map. ``` public function clear() : self ``` - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( [0, 1] )->clear(); // internal : [] ``` **See also:** - [except()](#except) - Returns a new map without the passed element keys - [only()](#only) - Returns only those elements specified by the keys - [reject()](#reject) - Removes all matched elements - [remove()](#remove) - Removes an element by key ### clone() [](#clone) Clones the map and all objects within. ``` public function clone() : self ``` - @return **self<int|string,mixed>** New map with cloned objects The objects within the Map are NOT the same as before but new cloned objects. This is different to [`copy()`](#copy), which doesn't clone the objects within. The keys are preserved using this method. **Examples:** ``` Map::from( [new \stdClass, new \stdClass] )->clone(); // [new \stdClass, new \stdClass] ``` **See also:** - [copy()](#copy) - Creates a new copy ### col() [](#col) Returns the values of a single column/property from an array of arrays or list of elements in a new map. ``` public function col( string $valuecol = null, string $indexcol = null ) : self ``` - @param **string|null** `$valuecol` Name or path of the value property - @param **string|null** `$indexcol` Name or path of the index property - @return **self<int|string,mixed>** New map with mapped entries If $indexcol is omitted, it's value is NULL or not set, the result will be indexed from 0-n. Items with the same value for $indexcol will overwrite previous items and only the last one will be part of the resulting map. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( [['id' => 'i1', 'val' => 'v1'], ['id' => 'i2', 'val' => 'v2']] )->col( 'val' ); // ['v1', 'v2'] Map::from( [['id' => 'i1', 'val' => 'v1'], ['id' => 'i2', 'val' => 'v2']] )->col( 'val', 'id' ); // ['i1' => 'v1', 'i2' => 'v2'] Map::from( [['id' => 'i1', 'val' => 'v1'], ['id' => 'i2', 'val' => 'v2']] )->col( null, 'id' ); // ['i1' => ['id' => 'i1', 'val' => 'v1'], 'i2' => ['id' => 'i2', 'val' => 'v2']] Map::from( [['id' => 'ix', 'val' => 'v1'], ['id' => 'ix', 'val' => 'v2']] )->col( null, 'id' ); // ['ix' => ['id' => 'ix', 'val' => 'v2']] Map::from( [['foo' => ['bar' => 'one', 'baz' => 'two']]] )->col( 'foo/baz', 'foo/bar' ); // ['one' => 'two'] Map::from( [['foo' => ['bar' => 'one']]] )->col( 'foo/baz', 'foo/bar' ); // ['one' => null] Map::from( [['foo' => ['baz' => 'two']]] )->col( 'foo/baz', 'foo/bar' ); // ['two'] ``` **See also:** - [map()](#map) - Applies a callback to each element and returns the results - [pluck()](#pluck) - Creates a key/value mapping (alias) - [rekey()](#pluck) - Changes the keys according to the passed function ### collapse() [](#collapse) Collapses all sub-array elements recursively to a new map. ``` public function collapse( int $depth = null ) : self ``` - @param **int|null** `$depth` Number of levels to collapse for multi-dimensional arrays or NULL for all - @return **self<int|string,mixed>** New map with all sub-array elements added into it recursively, up to the specified depth The keys are preserved and already existing elements will be overwritten. This is also true for numeric keys! This method is similar than [flat()](#flat) but replaces already existing elements. A value smaller than 1 for depth will return the same map elements. Collapsing does also work if elements implement the "Traversable" interface (which the Map object does). **Examples:** ``` Map::from( [0 => ['a' => 0, 'b' => 1], 1 => ['c' => 2, 'd' => 3]] )->collapse(); // ['a' => 0, 'b' => 1, 'c' => 2, 'd' => 3] Map::from( [0 => ['a' => 0, 'b' => 1], 1 => ['a' => 2]] )->collapse(); // ['a' => 2, 'b' => 1] Map::from( [0 => [0 => 0, 1 => 1], 1 => [0 => ['a' => 2, 0 => 3], 1 => 4]] )->collapse(); // [0 => 3, 1 => 4, 'a' => 2] Map::from( [0 => [0 => 0, 'a' => 1], 1 => [0 => ['b' => 2, 0 => 3], 1 => 4]] )->collapse( 1 ); // [0 => ['b' => 2, 0 => 3], 1 => 4, 'a' => 1] Map::from( [0 => [0 => 0, 'a' => 1], 1 => Map::from( [0 => ['b' => 2, 0 => 3], 1 => 4] )] )->collapse(); // [0 => 3, 'a' => 1, 'b' => 2, 1 => 4] ``` **See also:** - [flat()](#flat) - Flattens multi-dimensional elements without overwriting elements ### combine() [](#combine) Combines the values of the map as keys with the passed elements as values. ``` public function combine( iterable $values ) : self ``` - @param **iterable<int|string,mixed>** `$values` Values of the new map - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['name', 'age'] )->combine( ['Tom', 29] ); // ['name' => 'Tom', 'age' => 29] ``` **See also:** - [zip()](#zip) - Merges the values of all arrays at the corresponding index ### concat() [](#concat) Pushs all of the given elements onto the map without creating a new map. ``` public function concat( iterable $elements ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @return **self<int|string,mixed>** Updated map for fluid interface The keys of the passed elements are NOT preserved! **Examples:** ``` Map::from( ['foo'] )->concat( ['bar'] ); // ['foo', 'bar'] Map::from( ['foo'] )->concat( new Map( ['bar' => 'baz'] ) ); // ['foo', 'baz'] ``` **See also:** - [merge()](#merge) - Merges the map with the given elements without returning a new map - [union()](#union) - Builds a union of the elements and the given elements without returning a new map ### contains() [](#contains) Determines if an item exists in the map. ``` public function contains( $key, string $operator = null, $value = null ) : bool ``` This method combines the power of the `where()` method with `some()` to check if the map contains at least one of the passed values or conditions. - @param **\\Closure|iterable|mixed** `$values` Anonymous function with (item, key) parameter, element or list of elements to test against - @param **string|null** `$op` Operator used for comparison - @param **mixed** `$value` Value used for comparison - @return **bool** TRUE if at least one element is available in map, FALSE if the map contains none of them Check the [`where()`](#where)\] method for available operators. **Examples:** ``` Map::from( ['a', 'b'] )->contains( 'a' ); // true Map::from( ['a', 'b'] )->contains( ['a', 'c'] ); // true Map::from( ['a', 'b'] )->contains( function( $item, $key ) { return $item === 'a' } ); // true Map::from( [['type' => 'name']] )->contains( 'type', 'name' ); // true Map::from( [['type' => 'name']] )->contains( 'type', '!=', 'name' ); // false ``` **See also:** - [in()](#in) - Tests if element is included - [includes()](#includes) - Tests if element is included - [where()](#where) - Filters the list of elements by a given condition ### copy() [](#copy) Creates a new map with the same elements. ``` public function copy() : self ``` - @return **self<int|string,mixed>** New map Both maps share the same array until one of the map objects modifies the array. Then, the array is copied and the copy is modfied (copy on write). **Examples:** ``` $m = Map::from( ['foo', 'bar'] ); $m2 = $m->copy(); // internal: ['foo', 'bar'] both two maps ``` **See also:** - [clone()](#clone) - Clones the map and all objects within ### count() [](#count) Counts the number of elements in the map. ``` public function count() : int ``` - @return **int** Number of elements **Examples:** ``` Map::from( ['foo', 'bar'] )->count(); // 2 ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [countBy()](#countby) - Counts how often the same values are in the map - [max()](#max) - Returns the maximum value of all elements - [min()](#min) - Returns the minium value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test - [sum()](#sum) - Returns the sum of all values in the map ### countBy() [](#countby) Counts how often the same values are in the map. ``` public function countBy( $col = null ) : self ``` - @param **\\Closure|string|null** `$col` Key as "key1/key2/key3" or closure with (value, key) parameters returning the values for counting - @return **self<int|string,mixed>** New map with values as keys and their count as value This does also work for multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. "key1/key2/key3" to get "val" from \['key1' => \['key2' => \['key3' => 'val'\]\]\]. The same applies to public properties of objects or objects implementing \_\_isset() and \_\_get() methods. **Examples:** ``` Map::from( [1, 'foo', 2, 'foo', 1] )->countBy(); // [1 => 2, 'foo' => 2, 2 => 1] Map::from( [1.11, 3.33, 3.33, 9.99] )->countBy(); // ['1.11' => 1, '3.33' => 2, '9.99' => 1] Map::from( [['i' => ['p' => 1.11]], ['i' => ['p' => 3.33]], ['i' => ['p' => 3.33]]] )->countBy( 'i/p' ); // ['1.11' => 1, '3.33' => 2] Map::from( ['a@gmail.com', 'b@yahoo.com', 'c@gmail.com'] )->countBy( function( $email ) { return substr( strrchr( $email, '@' ), 1 ); } ); // ['gmail.com' => 2, 'yahoo.com' => 1] ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [groupBy()](#groupby) - Groups associative array elements or objects by the passed key or closure - [max()](#max) - Returns the maximum value of all elements - [min()](#min) - Returns the minium value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test - [sum()](#sum) - Returns the sum of all values in the map ### dd() [](#dd) Dumps the map content and terminates the script. ``` public function dd( callable $callback = null ) : void ``` - @param **callable|null** `$callback` Function receiving the map elements as parameter (optional) The `dd()` method is very helpful to see what are the map elements passed between two map methods in a method call chain. It stops execution of the script afterwards to avoid further output. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->sort()->dd()->first(); /* Array ( [0] => bar [1] => foo ) */ ``` The `first()` method isn't executed at all. ### delimiter() [](#delimiter) Sets or returns the seperator for paths to values in multi-dimensional arrays or objects. ``` public static function delimiter( ?string $char = null ) : string ``` - @param **string|null** `$char` Separator character, e.g. "." for "key.to.value" instaed of "key/to/value" - @return **string** Separator used up to now The static method only changes the separator for new maps created afterwards. Already existing maps will continue to use the previous separator. To change the separator of an existing map, use the [sep()](#sep) method instead. **Examples:** ``` Map::delimiter( '.' ); // '/' Map::from( ['foo' => ['bar' => 'baz']] )->get( 'foo.bar' ); // 'baz' ``` **See also:** - [sep()](#sep) - Sets the seperator for paths to values in multi-dimensional arrays or objects ### diff() [](#diff) Returns the keys/values in the map whose values are not present in the passed elements in a new map. ``` public function diff( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (valueA, valueB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->diff( ['bar'] ); // ['a' => 'foo'] ``` If a callback is passed, the given function will be used to compare the values. The function must accept two parameters (value A and B) and must return -1 if value A is smaller than value B, 0 if both are equal and 1 if value A is greater than value B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->diff( [0 => 'A'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diff( ['B' => 'A'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diff( ['c' => 'A'], function( $valA, $valB ) { return strtolower( $valA ) strtolower( $valB ); } ); // [] ``` All examples will return an empty map because both contain the same values when compared case insensitive. The keys are preserved using this method. **See also:** - [diffAssoc()](#diffassoc) - Returns the keys/values in the map whose keys AND values are not present in the passed elements in a new map - [diffKeys()](#diffkeys) - Returns the elements missing in the given list by keys ### diffAssoc() [](#diffassoc) Returns the keys/values in the map whose keys AND values are not present in the passed elements in a new map. ``` public function diffAssoc( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (valueA, valueB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->diffAssoc( new Map( ['foo', 'b' => 'bar'] ) ); // ['a' => 'foo'] ``` If a callback is passed, the given function will be used to compare the values. The function must accept two parameters (valA, valB) and must return -1 if value A is smaller than value B, 0 if both are equal and 1 if value A is greater than value B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->diffAssoc( [0 => 'A'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diffAssoc( ['B' => 'A'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diffAssoc( ['c' => 'A'], function( $valA, $valB ) { return strtolower( $valA ) strtolower( $valB ); } ); // ['b' => 'a'] ``` The first and second example will return an empty map because both contain the same values when compared case insensitive. In the third example, the keys doesn't match ("b" vs. "c"). The keys are preserved using this method. **See also:** - [diff()](#diff) - Returns the keys/values in the map whose values are not present in the passed elements in a new map a new map - [diffKeys()](#diffkeys) - Returns the elements missing in the given list by keys ### diffKeys() [](#diffkeys) Returns the key/value pairs from the map whose keys are not present in the passed elements in a new map. ``` public function diffKeys( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (keyA, keyB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->diffKeys( new Map( ['foo', 'b' => 'baz'] ) ); // ['a' => 'foo'] ``` If a callback is passed, the given function will be used to compare the keys. The function must accept two parameters (key A and B) and must return -1 if key A is smaller than key B, 0 if both are equal and 1 if key A is greater than key B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->diffKeys( [0 => 'A'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diffKeys( ['B' => 'X'], 'strcasecmp' ); // [] Map::from( ['b' => 'a'] )->diffKeys( ['c' => 'a'], function( $keyA, $keyB ) { return strtolower( $keyA ) strtolower( $keyB ); } ); // ['b' => 'a'] ``` The first and second example will return an empty map because both contain the same keys when compared case insensitive. The third example will return \['b' => 'a'\] because the keys doesn't match ("b" vs. "c"). The keys are preserved using this method. **See also:** - [diff()](#diff) - Returns the keys/values in the map whose values are not present in the passed elements in a new map - [diffAssoc()](#diffassoc) - Returns the keys/values in the map whose keys AND values are not present in the passed elements in a new map ### dump() [](#dump) Dumps the map content using the given function (print\_r by default). ``` public function dump( callable $callback = null ) : self ``` - @param **callable|null** `$callback` Function receiving the map elements as parameter (optional) - @return **self<int|string,mixed>** Same map for fluid interface The `dump()` method is very helpful to see what are the map elements passed between two map methods in a method call chain. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->dump()->asort()->dump( 'var_dump' ); /* Array ( [a] => foo [b] => bar ) array(1) { ["b"]=> string(3) "bar" ["a"]=> string(3) "foo" } */ ``` ### duplicates() [](#duplicates) Returns the duplicate values from the map. ``` public function duplicates( $col = null ) : self ``` - @param **\\Closure|string|null** `$col` Key, path of the nested array or anonymous function with ($item, $key) parameters returning the value for comparison - @return **self<int|string,mixed>** New map For nested arrays, you have to pass the name of the column of the nested array which should be used to check for duplicates. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. The keys in the result map are preserved. **Examples:** ``` Map::from( [1, 2, '1', 3] )->duplicates() // [2 => '1'] Map::from( [['p' => '1'], ['p' => 1], ['p' => 2]] )->duplicates( 'p' ) // [1 => ['p' => 1]] Map::from( [['i' => ['p' => '1']], ['i' => ['p' => 1]]] )->duplicates( 'i/p' ) // [1 => ['i' => ['p' => 1]]] Map::from( [['i' => ['p' => '1']], ['i' => ['p' => 1]]] )->unique( fn( $item, $key ) => $item['i']['p'] ); // [1 => ['i' => ['p' => 1]]] ``` **See also:** - [reject()](#reject) - Removes all matched elements - [unique()](#unique) - Returns only unique elements from the map in a new map ### each() [](#each) Executes a callback over each entry until FALSE is returned. ``` public function each( \Closure $callback ) : self ``` - @param **\\Closure** `$callback` Function with (value, key) parameters and returns TRUE/FALSE - @return **self<int|string,mixed>** Same map for fluid interface **Examples:** ``` $result = []; Map::from( [0 => 'a', 1 => 'b'] )->each( function( $value, $key ) use ( &$result ) { $result[$key] = strtoupper( $value ); return false; } ); // $result = [0 => 'A'] ``` The `$result` array will contain `[0 => 'A']` because FALSE is returned after the first entry and all other entries are then skipped. ### empty() [](#empty) Determines if the map is empty or not. ``` public function empty() : bool ``` - @return **bool** TRUE if map is empty, FALSE if not The method is equivalent to isEmpty(). **Examples:** ``` Map::from( [] )->empty(); // true Map::from( ['a'] )->empty(); // false ``` **See also:** - [isEmpty()](#isempty) - Determines if the map is empty or not ### equals() [](#equals) Tests if the passed elements are equal to the elements in the map. ``` public function equals( iterable $elements ) : bool ``` - @param **iterable<int|string,mixed>** `$elements` List of elements to test against - @return **bool** TRUE if both are equal, FALSE if not The method differs to [is()](#is) in the fact that it doesn't care about the keys by default. The elements are only loosely compared and the keys are ignored. Values are compared by their string values: ``` (string) $item1 === (string) $item2 ``` **Examples:** ``` Map::from( ['a'] )->equals( ['a', 'b'] ); // false Map::from( ['a', 'b'] )->equals( ['b'] ); // false Map::from( ['a', 'b'] )->equals( ['b', 'a'] ); // true ``` **See also:** - [is()](#is) - Tests if the map consists of the same keys and values ### every() [](#every) Verifies that all elements pass the test of the given callback. ``` public function every( \Closure $callback ) : bool ``` - @param **\\Closure** `$callback` Function with (value, key) parameters and returns TRUE/FALSE - @return **bool** True if all elements pass the test, false if if fails for at least one element **Examples:** ``` Map::from( [0 => 'a', 1 => 'b'] )->every( function( $value, $key ) { return is_string( $value ); } ); // true Map::from( [0 => 'a', 1 => 100] )->every( function( $value, $key ) { return is_string( $value ); } ); // false ``` **See also:** - [some()](#some) - Tests if at least one element passes the test or is part of the map - [any()](#any) - Tests if at least one element satisfies the callback function ### except() [](#except) Returns a new map without the passed element keys. ``` public function except( $keys ) : self ``` - @param **iterable<int|string>|array<int|string>|string|int** `$keys` List of keys to remove - @return **self<int|string,mixed>** New map The keys in the result map are preserved. **Examples:** ``` Map::from( ['a' => 1, 'b' => 2, 'c' => 3] )->except( 'b' ); // ['a' => 1, 'c' => 3] Map::from( [1 => 'a', 2 => 'b', 3 => 'c'] )->except( [1, 3] ); // [2 => 'b'] ``` **See also:** - [clear()](#clear) - Removes all elements from the current map - [only()](#only) - Returns only those elements specified by the keys - [reject()](#reject) - Removes all matched elements - [remove()](#remove) - Removes an element by key ### explode() [](#explode) Creates a new map with the string splitted by the delimiter. ``` public static function explode( string $delimiter , string $string , int $limit = PHP_INT_MAX ) : self ``` - @param **string** `$delimiter` Delimiter character, string or empty string - @param **string** `$string` String to split - @param **int** `$limit` Maximum number of element with the last element containing the rest of the string - @return **self<int|string,mixed>** New map with splitted parts A limit of "0" is treated the same as "1". If limit is negative, the rest of the string is dropped and not part of the returned map. This method creates a lazy Map and the string is split after calling another method that operates on the Map contents. **Examples:** ``` Map::explode( ',', 'a,b,c' ); // ['a', 'b', 'c'] Map::explode( '', 'a ab bc c' ); // ['a a', 'b b', 'c c'] Map::explode( '', 'string' ); // ['s', 't', 'r', 'i', 'n', 'g'] Map::explode( '|', 'a|b|c', 2 ); // ['a', 'b|c'] Map::explode( '', 'string', 2 ); // ['s', 't', 'ring'] Map::explode( '|', 'a|b|c|d', -2 ); // ['a', 'b'] Map::explode( '', 'string', -3 ); // ['s', 't', 'r'] ``` ### fill() [](#fill) Creates a new map filled with given value. ``` public static function fill( int $num, $value, int $start = 0 ) : self ``` - @param **int** `$num` Number of elements to create - @param **mixed** `$value` Value to fill the map with - @param **int** `$start` Start index for the elements - @return **self<int|string,mixed>** New map with filled elements **Examples:** ``` Map::fill( 3, 'a' ); // [0 => 'a', 1 => 'a', 2 => 'a'] Map::fill( 3, 'a', 2 ); // [2 => 'a', 3 => 'a', 4 => 'a'] Map::fill( 3, 'a', -2 ); // [-2 => 'a', -1 => 'a', 0 => 'a'] (PHP 8) // [-2 => 'a', 0 => 'a', 1 => 'a'] (PHP 7) ``` ### filter() [](#filter) Runs a filter over each element of the map and returns a new map. ``` public function filter( callable $callback = null ) : self ``` - @param **callable|null** `$callback` Function with (item, key) parameters and returns TRUE/FALSE - @return **self<int|string,mixed>** New map If no callback is passed, all values which are empty, null or false will be removed if their value converted to boolean is FALSE: ``` (bool) $value === false ``` The keys in the result map are preserved. **Examples:** ``` Map::from( [null, 0, 1, '', '0', 'a'] )->filter(); // [1, 'a'] Map::from( [2 => 'a', 6 => 'b', 13 => 'm', 30 => 'z'] )->filter( function( $value, $key ) { return $key < 10 && $value < 'n'; } ); // ['a', 'b'] ``` **See also:** - [grep()](#grep) - Applies a regular expression to all elements - [where()](#where) - Filters the list of elements by a given condition ### find() [](#find) Returns the first matching element where the callback returns TRUE. ``` public function find( \Closure $callback, $default = null, bool $reverse = false ) ``` - @param **\\Closure** `$callback` Function with (value, key) parameters and returns TRUE/FALSE - @param **mixed** `$default` Default value, closure or exception if the callback only returns FALSE - @param **bool** `$reverse` TRUE to test elements from back to front, FALSE for front to back (default) - @return **mixed|null** First matching value, passed default value or an exception **Examples:** ``` Map::from( ['a', 'c', 'e'] )->find( function( $value, $key ) { return $value >= 'b'; } ); // 'c' Map::from( ['a', 'c', 'e'] )->find( function( $value, $key ) { return $value >= 'b'; }, null, true ); // 'e' because $reverse = true Map::from( [] )->find( function( $value, $key ) { return $value >= 'b'; }, 'none' ); // 'none' Map::from( [] )->find( function( $value, $key ) { return $value >= 'b'; }, fn() => 'none' ); // 'none' Map::from( [] )->find( function( $value, $key ) { return $value >= 'b'; }, new \Exception( 'error' ) ); // throws \Exception ``` **See also:** - [findKey()](#findkey) - Returns the first matching key where the callback returns TRUE ### findKey() [](#findkey) Returns the first matching key where the callback returns TRUE. ``` public function findKey( \Closure $callback, $default = null, bool $reverse = false ) ``` - @param **\\Closure** `$callback` Function with (value, key) parameters and returns TRUE/FALSE - @param **mixed** `$default` Default value, closure or exception if the callback only returns FALSE - @param **bool** `$reverse` TRUE to test elements from back to front, FALSE for front to back (default) - @return **mixed|null** First matching value, passed default value or an exception **Examples:** ``` Map::from( ['a', 'c', 'e'] )->findKey( function( $value, $key ) { return $value >= 'b'; } ); // 1 because array has keys 0, 1 and 2 Map::from( ['a', 'c', 'e'] )->findKey( function( $value, $key ) { return $value >= 'b'; }, null, true ); // 2 because array is reversed and 'e' >= 'b' Map::from( [] )->findKey( function( $value, $key ) { return $value >= 'b'; }, fn() => 'none' ); // default value 'none' Map::from( [] )->findKey( function( $value, $key ) { return $value >= 'b'; }, new \Exception( 'error' ) ); // throws exception ``` **See also:** - [find()](#find) - Returns the first matching element where the callback returns TRUE ### first() [](#first) Returns the first element from the map. ``` public function first( $default = null ) ``` - @param **mixed** `$default` Default value, closure or exception if the map contains no elements - @return **mixed** First value of map, (generated) default value or an exception Using this method doesn't affect the internal array pointer. **Examples:** ``` Map::from( ['a', 'b'] )->first(); // 'a' Map::from( [] )->first( 'x' ); // 'x' Map::from( [] )->first( new \Exception( 'error' ) ); // throws \Exception Map::from( [] )->first( function() { return rand(); } ); // random integer ``` **See also:** - [firstKey()](#firstkey) - Returns the key of the first element from the map - [last()](#last) - Returns the last element from the map - [lastKey()](#lastkey) - Returns the key of the last element from the map ### firstKey() [](#firstkey) Returns the key of the first element from the map. ``` public function firstKey( $default = null ) ``` - @param **mixed** `$default` Default value, closure or exception if the map contains no elements - @return **mixed** First key of map, (generated) default value or an exception Using this method doesn't affect the internal array pointer. **Examples:** ``` Map::from( ['a' => 1, 'b' => 2] )->firstKey(); // 'a' Map::from( [] )->firstKey( 'x' ); // 'x' Map::from( [] )->firstKey( new \Exception( 'error' ) ); // throws \Exception Map::from( [] )->firstKey( function() { return rand(); } ); // random integer ``` **See also:** - [first()](#first) - Returns the first element from the map - [last()](#last) - Returns the last element from the map - [lastKey()](#lastkey) - Returns the last key from the map ### flat() [](#flat) Creates a new map with all sub-array elements added recursively. ``` public function flat( int $depth = null ) : self ``` - @param **int|null** `$depth` Number of levels to flatten multi-dimensional arrays - @return **self<int|string,mixed>** New map with all sub-array elements added into it recursively, up to the specified depth The keys are not preserved and the new map elements will be numbered from 0-n. A value smaller than 1 for depth will return the same map elements indexed from 0-n. Flattening does also work if elements implement the "Traversable" interface (which the Map object does). This method is similar than [collapse()](#collapse) but doesn't replace existing elements. Keys are NOT preserved using this method! **Examples:** ``` Map::from( [[0, 1], [2, 3]] )->flat(); // [0, 1, 2, 3] Map::from( [[0, 1], [[2, 3], 4]] )->flat(); // [0, 1, 2, 3, 4] Map::from( [[0, 1], [[2, 3], 4]] )->flat( 1 ); // [0, 1, [2, 3], 4] Map::from( [[0, 1], Map::from( [[2, 3], 4] )] )->flat(); // [0, 1, 2, 3, 4] ``` **See also:** - [collapse()](#collapse) - Collapses all sub-array elements recursively to a new map ### flatten() [](#flatten) Creates a new map with keys joined recursively. ``` public function flatten( ?int $depth = null ) : self ``` - @param **int|null** `$depth` Number of levels to flatten multi-dimensional arrays or NULL for all - @return **self<string,mixed>** New map with keys joined recursively, up to the specified depth To create the original multi-dimensional array again, use the [unflatten()](#unflatten) method. **Examples:** ``` Map::from( ['a' => ['b' => ['c' => 1, 'd' => 2]], 'b' => ['e' => 3]] )->flatten(); // ['a/b/c' => 1, 'a/b/d' => 2, 'b/e' => 3] Map::from( ['a' => ['b' => ['c' => 1, 'd' => 2]], 'b' => ['e' => 3]] )->flatten( 1 ); // ['a/b' => ['c' => 1, 'd' => 2], 'b/e' => 3] Map::from( ['a' => ['b' => ['c' => 1, 'd' => 2]], 'b' => ['e' => 3]] )->sep( '.' )->flatten(); // ['a.b.c' => 1, 'a.b.d' => 2, 'b.e' => 3] ``` **See also:** - [flat()](#flat) - Flattens multi-dimensional elements without overwriting elements - [collapse()](#collapse) - Collapses all sub-array elements recursively to a new map - [unflatten()](#unflatten) - Unflattens the key path/value pairs into a multi-dimensional array ### flip() [](#flip) Exchanges the keys with their values and vice versa. ``` public function flip() : self ``` - @return **self<int|string,mixed>** New map with keys as values and values as keys **Examples:** ``` Map::from( ['a' => 'X', 'b' => 'Y'] )->flip(); // ['X' => 'a', 'Y' => 'b'] ``` ### float() [](#float) Returns an element by key and casts it to float if possible. ``` public function float( $key, $default = 0.0 ) : float ``` - @param **int|string** `$key` Key or path to the requested item - @param **mixed** `$default` Default value if key isn't found (will be casted to float) - @return **float** Value from map or default value This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => true] )->float( 'a' ); // 1.0 (casted to float) Map::from( ['a' => 1] )->float( 'a' ); // 1.0 (casted to float) Map::from( ['a' => '1.1'] )->float( 'a' ); // 1.1 (casted to float) Map::from( ['a' => '10'] )->float( 'a' ); // 10.0 (casted to float) Map::from( ['a' => ['b' => ['c' => 1.1]]] )->float( 'a/b/c' ); // 1.1 Map::from( [] )->float( 'c', function() { return 1.1; } ); // 1.1 Map::from( [] )->float( 'a', 1 ); // 1.0 (default value used) Map::from( [] )->float( 'a' ); // 0.0 Map::from( ['b' => ''] )->float( 'b' ); // 0.0 (casted to float) Map::from( ['a' => 'abc'] )->float( 'a' ); // 0.0 (casted to float) Map::from( ['b' => null] )->float( 'b' ); // 0.0 (null is not scalar) Map::from( ['b' => [true]] )->float( 'b' ); // 0.0 (arrays are not scalar) Map::from( ['b' => '#resource'] )->float( 'b' ); // 0.0 (resources are not scalar) Map::from( ['b' => new \stdClass] )->float( 'b' ); // 0.0 (objects are not scalar) Map::from( [] )->float( 'c', new \Exception( 'error' ) ); // throws exception ``` **See also:** - [bool()](#bool) - Returns an element by key and casts it to boolean if possible - [cast()](#cast) - Casts all entries to the passed type - [get()](#get) - Returns an element from the map by key - [int()](#int) - Returns an element by key and casts it to integer if possible - [string()](#string) - Returns an element by key and casts it to string if possible ### from() [](#from) Creates a new map instance if the value isn't one already. ``` public static function from( $elements = [] ) : self ``` - @param **mixed** `$elements` List of elements or single value - @return **self<int|string,mixed>** New map **Examples:** ``` // array Map::from( [] ); // null Map::from( null ); // scalar Map::from( 'a' ); // object Map::from( new \stdClass() ); // map object Map::from( new Map() ); // iterable object Map::from( new ArrayObject() ); // closure evaluated lazily Map::from( function() { return []; } ); ``` **See also:** - [fromJson()](#fromjson) - Creates a new map instance from a JSON string ### fromJson() [](#fromjson) Creates a new map instance from a JSON string. ``` public static function fromJson( string $json, int $options = JSON_BIGINT_AS_STRING ) : self ``` - @param **int** `$options` Combination of JSON\_\* constants - @return **self<int|string,mixed>** New map from decoded JSON string - @throws **\\RuntimeException** If the passed JSON string is invalid There are several options available for decoding the JSON string which are described in the [PHP json\_decode() manual](https://www.php.net/manual/en/function.json-decode.php). The parameter can be a single JSON\_\* constant or a bitmask of several constants combine by bitwise OR (|), e.g.: This method creates a lazy Map and the string is decoded after calling another method that operates on the Map contents. Thus, the exception in case of an error isn't thrown immediately but after calling the next method. ``` JSON_BIGINT_AS_STRING|JSON_INVALID_UTF8_IGNORE ``` **Examples:** ``` Map::fromJson( '["a", "b"]' ); // ['a', 'b'] Map::fromJson( '{"a": "b"}' ); // ['a' => 'b'] Map::fromJson( '""' ); [''] ``` **See also:** - [from()](#from) - Creates a new map instance if the value isn't one already ### get() [](#get) Returns an element from the map by key. ``` public function get( $key, $default = null ) ``` - @param **int|string** `$key` Key or path to the requested item - @param **mixed** `$default` Default value if no element matches - @return **mixed** Value from map or default value This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => 'X', 'b' => 'Y'] )->get( 'a' ); // 'X' Map::from( ['a' => 'X', 'b' => 'Y'] )->get( 'c', 'Z' ); // 'Z' Map::from( ['a' => ['b' => ['c' => 'Y']]] )->get( 'a/b/c' ); // 'Y' Map::from( [] )->get( 'c', new \Exception( 'error' ) ); // throws \Exception Map::from( [] )->get( 'c', function() { return rand(); } ); // random integer ``` **See also:** - [bool()](#bool) - Returns an element by key and casts it to boolean if possible - [int()](#int) - Returns an element by key and casts it to integer if possible - [float()](#float) - Returns an element by key and casts it to float if possible - [pull()](#pull) - Returns and removes an element from the map by its key - [set()](#set) - Sets an element in the map by key without returning a new map - [string()](#string) - Returns an element by key and casts it to string if possible ### getIterator() [](#getiterator) Returns an iterator for the elements. ``` public function getIterator() : \ArrayIterator ``` - @return **\\Iterator** Over map elements This method will be used by e.g. `foreach()` to loop over all entries. **Examples:** ``` foreach( Map::from( ['a', 'b'] ) as $value ) { // ... } ``` ### grep() [](#grep) Returns only items which matches the regular expression. ``` public function grep( string $pattern, int $flags = 0 ) : self ``` - @param **string** `$pattern` Regular expression pattern, e.g. "/ab/" - @param **int** `$flags` PREG\_GREP\_INVERT to return elements not matching the pattern - @return **self<int|string,mixed>** New map containing only the matched elements All items are converted to string first before they are compared to the regular expression. Thus, fractions of ".0" will be removed in float numbers which may result in unexpected results. The keys are preserved using this method. **Examples:** ``` Map::from( ['ab', 'bc', 'cd'] )->grep( '/b/' ); // ['ab', 'bc'] Map::from( ['ab', 'bc', 'cd'] )->grep( '/a/', PREG_GREP_INVERT ); // ['bc', 'cd'] Map::from( [1.5, 0, 1.0, 'a'] )->grep( '/^(\d+)?\.\d+$/' ); // [1.5] // float 1.0 is converted to string "1" ``` **See also:** - [filter()](#filter) - Runs a filter over each element of the map and returns a new map - [where()](#where) - Filters the list of elements by a given condition ### groupBy() [](#groupby) Groups associative array elements or objects by the passed key or closure. ``` public function groupBy( $key ) : self ``` - @param **\\Closure|string|int** `$key` Closure function with (item, idx) parameters returning the key or the key itself to group by - @return **self<int|string,mixed>** New map with elements grouped by the given key Instead of overwriting items with the same keys like to the [col()](#col) method does, [groupBy()](#groupby) keeps all entries in sub-arrays. It's preserves the keys of the orignal map entries too. This does also work for multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. "key1/key2/key3" to get "val" from \['key1' => \['key2' => \['key3' => 'val'\]\]\]. The same applies to public properties of objects or objects implementing \_\_isset() and \_\_get() methods. **Examples:** ``` $list = [ 10 => ['aid' => 123, 'code' => 'x-abc'], 20 => ['aid' => 123, 'code' => 'x-def'], 30 => ['aid' => 456, 'code' => 'x-def'] ]; Map::from( $list )->groupBy( 'aid' ); /* [ 123 => [ 10 => ['aid' => 123, 'code' => 'x-abc'], 20 => ['aid' => 123, 'code' => 'x-def'] ], 456 => [ 30 => ['aid' => 456, 'code' => 'x-def'] ] ] */ Map::from( $list )->groupBy( function( $item, $key ) { return substr( $item['code'], -3 ); } ); /* [ 'abc' => [ 10 => ['aid' => 123, 'code' => 'x-abc'] ], 'def' => [ 20 => ['aid' => 123, 'code' => 'x-def'], 30 => ['aid' => 456, 'code' => 'x-def'] ] ] */ ``` In case the passed key doesn't exist in one or more items, these items are stored in a sub-array using an empty string as key: ``` $list = [ 10 => ['aid' => 123, 'code' => 'x-abc'], 20 => ['aid' => 123, 'code' => 'x-def'], 30 => ['aid' => 456, 'code' => 'x-def'] ]; Map::from( $list )->groupBy( 'xid' ); /* [ '' => [ 10 => ['aid' => 123, 'code' => 'x-abc'], 20 => ['aid' => 123, 'code' => 'x-def'], 30 => ['aid' => 456, 'code' => 'x-def'] ] ] */ ``` **See also:** - [countBy()](#countby) - Counts how often the same values are in the map ### has() [](#has) Determines if a key or several keys exists in the map. ``` public function has( $key ) : bool ``` - @param **array<int|string<|int|string** `$key` Key or path to the requested item - @return **bool** TRUE if key is available in map, FALSE if not If several keys are passed as array, all keys must exist in the map to return TRUE. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => 'X', 'b' => 'Y'] )->has( 'a' ); // true Map::from( ['a' => 'X', 'b' => 'Y'] )->has( ['a', 'b'] ); // false Map::from( ['a' => ['b' => ['c' => 'Y']]] )->has( 'a/b/c' ); // true Map::from( ['a' => 'X', 'b' => 'Y'] )->has( 'c' ); // false Map::from( ['a' => 'X', 'b' => 'Y'] )->has( ['a', 'c'] ); // false Map::from( ['a' => 'X', 'b' => 'Y'] )->has( 'X' ); // false ``` ### if() [](#if) Executes callbacks depending on the condition. ``` public function if( $condition, \Closure $then, \Closure $else = null ) : self ``` - @param **\\Closure|bool** `$condition` Boolean or function with (map) parameter returning a boolean - @param **\\Closure** `$then` Function with (map) parameter - @param **\\Closure|null** `$else` Function with (map) parameter (optional) - @return **self<int|string,mixed>** New map for fluid interface If callbacks for "then" and/or "else" are passed, these callbacks will be executed and their returned value is passed back within a Map object. In case no "then" or "else" closure is given, the method will return the same map object if the condition is true or an empty map object if it's false. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->if( 'a' == 'b', function( Map $_ ) { echo "then"; } ); // no output Map::from( ['a' => 1, 'b' => 0] )->if( function( Map $map ) { return $map->has( 'a' ); }, function( Map $_ ) { echo "then"; }, function( Map $_ ) { echo "else"; } ); // then Map::from( ['a' => 1, 'b' => 0] )->if( fn( Map $map ) => $map->has( 'c' ), function( Map $_ ) { echo "then"; }, function( Map $_ ) { echo "else"; } ); // else Map::from( ['a', 'b'] )->if( true, function( $map ) { return $map->push( 'c' ); } ); // ['a', 'b', 'c'] Map::from( ['a', 'b'] )->if( false, null, function( $map ) { return $map->pop(); } ); // ['b'] ``` Since PHP 7.4, you can also pass arrow function like `fn($map) => $map->has('c')`(a short form for anonymous closures) as parameters. The automatically have access to previously defined variables but can not modify them. Also, they can not have a void return type and must/will always return something. Details about [PHP arrow functions](https://www.php.net/manual/en/functions.arrow.php) **See also:** - [ifAny()](#ifany) - Executes callbacks depending if the map contains elements or not - [ifEmpty()](#ifempty) - Executes callbacks depending if the map is empty or not ### ifAny() [](#ifany) - Executes callbacks depending if the map contains elements or not. ``` public function ifAny( \Closure $then = null, \Closure $else = null ) : self ``` - @param **\\Closure|null** `$then` Function with (map, condition) parameter (optional) - @param **\\Closure|null** `$else` Function with (map, condition) parameter (optional) - @return **self<int|string,mixed>** New map for fluid interface If callbacks for "then" and/or "else" are passed, these callbacks will be executed and their returned value is passed back within a Map object. In case no "then" or "else" closure is given, the method will return the same map object. **Examples:** ``` Map::from( ['a'] )->ifAny( function( $map ) { $map->push( 'b' ); } ); // ['a', 'b'] Map::from( [] )->ifAny( null, function( $map ) { return $map->push( 'b' ); } ); // ['b'] Map::from( ['a'] )->ifAny( function( $map ) { return 'c'; } ); // ['c'] ``` Since PHP 7.4, you can also pass arrow function like `fn($map) => $map->has('c')`(a short form for anonymous closures) as parameters. The automatically have access to previously defined variables but can not modify them. Also, they can not have a void return type and must/will always return something. Details about [PHP arrow functions](https://www.php.net/manual/en/functions.arrow.php) **See also:** - [if()](#if) - Executes callbacks depending on the condition - [ifEmpty()](#ifempty) - Executes callbacks depending if the map is empty or not ### ifEmpty() [](#ifempty) - Executes callbacks depending if the map is empty or not. ``` public function ifEmpty( \Closure $then = null, \Closure $else = null ) : self ``` - @param **\\Closure|null** `$then` Function with (map, condition) parameter (optional) - @param **\\Closure|null** `$else` Function with (map, condition) parameter (optional) - @return **self<int|string,mixed>** New map for fluid interface If callbacks for "then" and/or "else" are passed, these callbacks will be executed and their returned value is passed back within a Map object. In case no "then" or "else" closure is given, the method will return the same map object. **Examples:** ``` Map::from( [] )->ifEmpty( function( $map ) { $map->push( 'a' ); } ); // ['a'] Map::from( ['a'] )->ifEmpty( null, function( $map ) { return $map->push( 'b' ); } ); // ['a', 'b'] ``` Since PHP 7.4, you can also pass arrow function like `fn($map) => $map->has('c')`(a short form for anonymous closures) as parameters. The automatically have access to previously defined variables but can not modify them. Also, they can not have a void return type and must/will always return something. Details about [PHP arrow functions](https://www.php.net/manual/en/functions.arrow.php) **See also:** - [if()](#if) - Executes callbacks depending on the condition - [ifAny()](#ifany) - Executes callbacks depending if the map contains elements or not ### implements() [](#implements) Tests if all entries in the map are objects implementing the given interface. ``` public function implements( string $interface, $throw = false ) : bool ``` - @param **string** `$interface` Name of the interface that must be implemented - @param **\\Throwable|bool** `$throw` Passing TRUE or an exception name will throw the exception instead of returning FALSE - @return **bool** TRUE if all entries implement the interface or FALSE if at least one doesn't - @throws **\\UnexpectedValueException|\\Throwable** If one entry doesn't implement the interface **Examples:** ``` Map::from( [new Map(), new Map()] )->implements( '\Countable' ); // true Map::from( [new Map(), new \stdClass()] )->implements( '\Countable' ); // false Map::from( [new Map(), 123] )->implements( '\Countable' ); // false Map::from( [new Map(), 123] )->implements( '\Countable', true ); // throws \UnexpectedValueException Map::from( [new Map(), 123] )->implements( '\Countable', '\RuntimeException' ); // throws \RuntimeException ``` ### in() [](#in) Tests if the passed element or elements are part of the map. ``` public function in( $element, bool $strict = false ) : bool ``` - @param **mixed|array** `$element` Element or elements to search for in the map - @param **bool** `$strict` TRUE to check the type too, using FALSE '1' and 1 will be the same - @return **bool** TRUE if all elements are available in map, FALSE if not **Examples:** ``` Map::from( ['a', 'b'] )->in( 'a' ); // true Map::from( ['a', 'b'] )->in( ['a', 'b'] ); // true Map::from( ['a', 'b'] )->in( 'x' ); // false Map::from( ['a', 'b'] )->in( ['a', 'x'] ); // false Map::from( ['1', '2'] )->in( 2, true ); // false ``` **See also:** - [compare()](#compare) - Compares the value against all map elements - [contains()](#contains) - Tests if an item exists in the map - [includes()](#includes) - Tests if element is included - [none()](#none) - Tests if none of the elements are part of the map ### includes() [](#includes) Tests if the passed element or elements are part of the map (alias). ``` public function includes( $element, bool $strict = false ) : bool ``` - @param **mixed|array** `$element` Element or elements to search for in the map - @param **bool** `$strict` TRUE to check the type too, using FALSE '1' and 1 will be the same - @return **bool** TRUE if all elements are available in map, FALSE if not This method is an alias for [in()](#in). For performance reasons, `in()` should be preferred because it uses one method call less than `includes()`. **See also:** - [compare()](#compare) - Compares the value against all map elements - [contains()](#contains) - Tests if an item exists in the map - [in()](#in) - Tests if element is included - [none()](#none) - Tests if none of the elements are part of the map ### index() [](#index) Returns the numerical index of the given key. ``` public function index( $value ) : ?int ``` - @param **\\Closure|string|int** `$value` Key to search for or function with (key) parameters return TRUE if key is found - @return **int|null** Position of the found value (zero based) or NULL if not found **Examples:** ``` Map::from( [4 => 'a', 8 => 'b'] )->index( '8' ); // 1 Map::from( [4 => 'a', 8 => 'b'] )->index( function( $key ) { return $key == '8'; } ); // 1 ``` Both examples will return "1" because the value "b" is at the second position and the returned index is zero based so the first item has the index "0". **See also:** - [at()](#at) - Returns the value at the given position - [pos()](#pos) - Returns the numerical index of the value ### insertAfter() [](#insertafter) Inserts the value or values after the given element. ``` public function insertAfter( $element, $value ) : self ``` - @param **mixed** `$element` Element after the value is inserted - @param **mixed** `$value` Element or list of elements to insert - @return **self<int|string,mixed>** Updated map for fluid interface Numerical array indexes are not preserved. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertAfter( 'foo', 'baz' ); // ['a' => 'foo', 0 => 'baz', 'b' => 'bar'] Map::from( ['foo', 'bar'] )->insertAfter( 'foo', ['baz', 'boo'] ); // ['foo', 'baz', 'boo', 'bar'] Map::from( ['foo', 'bar'] )->insertAfter( null, 'baz' ); // ['foo', 'bar', 'baz'] ``` **See also:** - [insertAt()](#insertat) - Inserts the item at the given position in the map - [insertBefore()](#insertbefore) - Inserts the value or values before the given element ### insertAt() [](#insertat) Inserts the item at the given position in the map. ``` public function insertAt( int $pos, $value, $key = null ) : self ``` - @param **int** `$pos` Position the value should be inserted at - @param **mixed** `$value` Value to be inserted - @param **mixed|null** `$key` Value key or NULL to assign an integer key automatically - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertAt( 0, 'baz' ); // [0 => 'baz', 'a' => 'foo', 'b' => 'bar'] Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertAt( 1, 'baz', 'c' ); // ['a' => 'foo', 'c' => 'baz', 'b' => 'bar'] Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertAt( 5, 'baz' ); // ['a' => 'foo', 'b' => 'bar', 'c' => 'baz'] Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertAt( -1, 'baz', 'c' ); // ['a' => 'foo', 'c' => 'baz', 'b' => 'bar'] ``` **See also:** - [insertAfter()](#insertafter) - Inserts the value or values after the given element - [insertBefore()](#insertbefore) - Inserts the value or values before the given element ### insertBefore() [](#insertbefore) Inserts the value or values before the given element. ``` public function insertBefore( $element, $value ) : self ``` - @param **mixed** `$element` Element before the value is inserted - @param **mixed** `$value` Element or list of elements to insert - @return **self<int|string,mixed>** Updated map for fluid interface Numerical array indexes are not preserved. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->insertBefore( 'bar', 'baz' ); // ['a' => 'foo', 0 => 'baz', 'b' => 'bar'] Map::from( ['foo', 'bar'] )->insertBefore( 'bar', ['baz', 'boo'] ); // ['foo', 'baz', 'boo', 'bar'] Map::from( ['foo', 'bar'] )->insertBefore( null, 'baz' ); // ['foo', 'bar', 'baz'] ``` **See also:** - [insertAfter()](#insertafter) - Inserts the value or values after the given element - [insertAt()](#insertat) - Inserts the item at the given position in the map ### inString() [](#instring) Tests if the passed value or value are part of the strings in the map. This method is deprecated in favor of the multi-byte aware [strContains()](#strcontains) method. ``` public function inString( $value, bool $case = true ) : bool ``` - @param **array|string** `$value` Value or values to compare the map elements, will be casted to string type - @param **bool** `$case` TRUE if comparison is case sensitive, FALSE to ignore upper/lower case - @return **bool** TRUE If at least one element matches, FALSE if value is not in any string of the map All scalar values (bool, float, int and string) are casted to string values before comparing to the given value. Non-scalar values in the map are ignored. **Examples:** ``` Map::from( ['abc'] )->inString( 'c' ); // true ('abc' contains 'c') Map::from( ['abc'] )->inString( 'bc' ); // true ('abc' contains 'bc') Map::from( [12345] )->inString( '23' ); // true ('12345' contains '23') Map::from( [123.4] )->inString( 23.4 ); // true ('123.4' contains '23.4') Map::from( [12345] )->inString( false ); // true ('12345' contains '') Map::from( [12345] )->inString( true ); // true ('12345' contains '1') Map::from( [false] )->inString( false ); // true ('' contains '') Map::from( ['abc'] )->inString( '' ); // true ('abc' contains '') Map::from( [''] )->inString( false ); // true ('' contains '') Map::from( ['abc'] )->inString( 'BC', false ); // true ('abc' contains 'BC' when case-insentive) Map::from( ['abc', 'def'] )->inString( ['de', 'xy'] ); // true ('def' contains 'de') Map::from( ['abc', 'def'] )->inString( ['E', 'x'] ); // false (doesn't contain "E" when case sensitive) Map::from( ['abc', 'def'] )->inString( 'E' ); // false (doesn't contain "E" when case sensitive) Map::from( [23456] )->inString( true ); // false ('23456' doesn't contain '1') Map::from( [false] )->inString( 0 ); // false ('' doesn't contain '0') ``` **See also:** - [strContains()](#strcontains) - Tests if at least one of the passed strings is part of at least one entry - [strContainsAll()](#strcontainsall) - Tests if all of the entries contains one of the passed strings ### int() [](#int) Returns an element by key and casts it to integer if possible. ``` public function int( $key, $default = 0 ) : int ``` - @param **int|string** `$key` Key or path to the requested item - @param **mixed** `$default` Default value if key isn't found (will be casted to int) - @return **int** Value from map or default value This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => true] )->int( 'a' ); // 1 Map::from( ['a' => '1'] )->int( 'a' ); // 1 (casted to integer) Map::from( ['a' => 1.1] )->int( 'a' ); // 1 (casted to integer) Map::from( ['a' => '10'] )->int( 'a' ); // 10 (casted to integer) Map::from( ['a' => ['b' => ['c' => 1]]] )->int( 'a/b/c' ); // 1 Map::from( [] )->int( 'c', function() { return rand( 1, 1 ); } ); // 1 Map::from( [] )->int( 'a', 1 ); // 1 (default value used) Map::from( [] )->int( 'a' ); // 0 Map::from( ['b' => ''] )->int( 'b' ); // 0 (casted to integer) Map::from( ['a' => 'abc'] )->int( 'a' ); // 0 (casted to integer) Map::from( ['b' => null] )->int( 'b' ); // 0 (null is not scalar) Map::from( ['b' => [true]] )->int( 'b' ); // 0 (arrays are not scalar) Map::from( ['b' => '#resource'] )->int( 'b' ); // 0 (resources are not scalar) Map::from( ['b' => new \stdClass] )->int( 'b' ); // 0 (objects are not scalar) Map::from( [] )->int( 'c', new \Exception( 'error' ) ); // throws exception ``` **See also:** - [bool()](#bool) - Returns an element by key and casts it to boolean if possible - [cast()](#cast) - Casts all entries to the passed type - [get()](#get) - Returns an element from the map by key - [float()](#float) - Returns an element by key and casts it to float if possible - [string()](#string) - Returns an element by key and casts it to string if possible ### intersect() [](#intersect) Returns all values in a new map that are available in both, the map and the given elements. ``` public function intersect( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (valueA, valueB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->intersect( ['bar'] ); // ['b' => 'bar'] ``` If a callback is passed, the given function will be used to compare the values. The function must accept two parameters (vaA, valB) and must return -1 if value A is smaller than value B, 0 if both are equal and 1 if value A is greater than value B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->intersect( [0 => 'A'], 'strcasecmp' ); // ['a'] Map::from( ['b' => 'a'] )->intersect( ['B' => 'A'], 'strcasecmp' ); // ['a'] Map::from( ['b' => 'a'] )->intersect( ['c' => 'A'], function( $valA, $valB ) { return strtolower( $valA ) strtolower( $valB ); } ); // ['a'] ``` **See also:** - [intersectAssoc()](#intersectassoc) - Returns all values in a new map that are available in both, the map and the given elements while comparing the keys too - [intersectKeys()](#intersectkeys) - Returns all values in a new map that are available in both, the map and the given elements by comparing the keys only ### intersectAssoc() [](#intersectassoc) Returns all values in a new map that are available in both, the map and the given elements while comparing the keys too. ``` public function intersectAssoc( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (valueA, valueB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->intersectAssoc( new Map( ['foo', 'b' => 'bar'] ) ); // ['a' => 'foo'] ``` If a callback is passed, the given function will be used to compare the values. The function must accept two parameters (valA, valB) and must return -1 if value A is smaller than value B, 0 if both are equal and 1 if value A is greater than value B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->intersectAssoc( [0 => 'A'], 'strcasecmp' ); // [0 => 'a'] Map::from( ['b' => 'a'] )->intersectAssoc( ['B' => 'A'], 'strcasecmp' ); // ['b' => 'a'] Map::from( ['b' => 'a'] )->intersectAssoc( ['c' => 'A'], function( $valA, $valB ) { return strtolower( $valA ) strtolower( $valB ); } ); // [] ``` **See also:** - [intersect()](#intersect) - Returns all values in a new map that are available in both, the map and the given elements - [intersectKeys()](#intersectkeys) - Returns all values in a new map that are available in both, the map and the given elements by comparing the keys only ### intersectKeys() [](#intersectkeys) Returns all values in a new map that are available in both, the map and the given elements by comparing the keys only. ``` public function intersectKeys( iterable $elements, callable $callback = null ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **callable|null** `$callback` Function with (keyA, keyB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 'foo', 'b' => 'bar'] )->intersectKeys( new Map( ['foo', 'b' => 'baz'] ) ); // ['b' => 'bar'] ``` If a callback is passed, the given function will be used to compare the keys. The function must accept two parameters (key A and B) and must return -1 if key A is smaller than key B, 0 if both are equal and 1 if key A is greater than key B. Both, a method name and an anonymous function can be passed: ``` Map::from( [0 => 'a'] )->intersectKeys( [0 => 'A'], 'strcasecmp' ); // [0 => 'a'] Map::from( ['b' => 'a'] )->intersectKeys( ['B' => 'X'], 'strcasecmp' ); // ['b' => 'a'] Map::from( ['b' => 'a'] )->intersectKeys( ['c' => 'a'], function( $keyA, $keyB ) { return strtolower( $keyA ) strtolower( $keyB ); } ); // [] ``` **See also:** - [intersect()](#intersect) - Returns all values in a new map that are available in both, the map and the given elements - [intersectAssoc()](#intersectassoc) - Returns all values in a new map that are available in both, the map and the given elements while comparing the keys too ### is() [](#is) Tests if the map consists of the same keys and values ``` public function is( iterable $list, bool $strict = false ) : bool ``` - @param **iterable<int|string,mixed>** `$list` List of key/value pairs to compare with - @param **bool** `$strict` TRUE for comparing order of elements too, FALSE for key/values only - @return **bool** TRUE if given list is equal, FALSE if not **Examples:** ``` Map::from( ['a', 'b'] )->is( ['b', 'a'] ); // true Map::from( ['a', 'b'] )->is( ['b', 'a'], true ); // false Map::from( [1, 2] )->is( ['1', '2'] ); // false ``` **See also:** - [equals()](#equals) - Tests if the passed elements are equal to the elements in the map ### isEmpty() [](#isempty) Determines if the map is empty or not. ``` public function isEmpty() : bool ``` - @return **bool** TRUE if map is empty, FALSE if not The method is equivalent to [empty()](#empty). **Examples:** ``` Map::from( [] )->isEmpty(); // true Map::from( ['a'] )-isEmpty(); // false ``` **See also:** - [empty()](#empty) - Determines if the map is empty or not ### isList() [](#islist) Checks if the map contains a list of subsequentially numbered keys. ``` public function isList() : bool ``` - @return bool TRUE if the map is a list, FALSE if not **Examples:** ``` Map::from( [] )->isList(); // true Map::from( [1, 3, 2] )->isList(); // true, keys are 0, 1 and 2 Map::from( [0 => 1, 1 => 2, 2 => 3] )->isList(); // true, keys are consecutive Map::from( [1 => 1, 2 => 2, 3 => 3] )->isList(); // false, keys doesn't start with 0 Map::from( [0 => 1, 2 => 2, 3 => 3] )->isList(); // false, keys are not consecutive Map::from( ['a' => 1, 1 => 2, 'c' => 3] )->isList(); // false, keys are not all numeric ``` **See also:** - [isObject()](#isobject) - Determines if all entries are objects - [isNumeric()](#isnumeric) - Determines if all entries are numeric values - [isScalar()](#isscalar) - Determines if all entries are scalar values - [isString()](#isstring) - Determines if all entries are string values ### isObject() [](#isobject) Determines if all entries are objects. ``` public function isObject() : bool ``` - @return **bool** TRUE if all map entries are objects, FALSE if not **Examples:** ``` Map::from( [] )->isObject(); // true Map::from( [new stdClass] )->isObject(); // true Map::from( [1] )->isObject(); // false ``` **See also:** - [isList()](#islist) - Checks if the map contains a list of subsequentially numbered keys - [isNumeric()](#isnumeric) - Determines if all entries are numeric values - [isScalar()](#isscalar) - Determines if all entries are scalar values - [isString()](#isstring) - Determines if all entries are string values ### isNumeric() [](#isnumeric) Determines if all entries are numeric values. ``` public function isNumeric() : bool ``` - @return **bool** TRUE if all map entries are numeric values, FALSE if not **Examples:** ``` Map::from( [] )->isNumeric(); // true Map::from( [1] )->isNumeric(); // true Map::from( [1.1] )->isNumeric(); // true Map::from( [010] )->isNumeric(); // true Map::from( [0x10] )->isNumeric(); // true Map::from( [0b10] )->isNumeric(); // true Map::from( ['010'] )->isNumeric(); // true Map::from( ['10'] )->isNumeric(); // true Map::from( ['10.1'] )->isNumeric(); // true Map::from( [' 10 '] )->isNumeric(); // true Map::from( ['10e2'] )->isNumeric(); // true Map::from( ['0b10'] )->isNumeric(); // false Map::from( ['0x10'] )->isNumeric(); // false Map::from( ['null'] )->isNumeric(); // false Map::from( [null] )->isNumeric(); // false Map::from( [true] )->isNumeric(); // false Map::from( [[]] )->isNumeric(); // false Map::from( [''] )->isNumeric(); // false ``` **See also:** - [isList()](#islist) - Checks if the map contains a list of subsequentially numbered keys - [isObject()](#isobject) - Determines if all entries are objects - [isScalar()](#isscalar) - Determines if all entries are scalar values - [isString()](#isstring) - Determines if all entries are string values ### isScalar() [](#isscalar) Determines if all entries are scalar values. ``` public function isScalar() : bool ``` - @return **bool** TRUE if all map entries are scalar values, FALSE if not **Examples:** ``` Map::from( [] )->isScalar(); // true Map::from( [1] )->isScalar(); // true Map::from( [1.1] )->isScalar(); // true Map::from( ['abc'] )->isScalar(); // true Map::from( [true, false] )->isScalar(); // true Map::from( [new stdClass] )->isScalar(); // false Map::from( [resource] )->isScalar(); // false Map::from( [null] )->isScalar(); // false Map::from( [[1]] )->isScalar(); // false ``` **See also:** - [isList()](#islist) - Checks if the map contains a list of subsequentially numbered keys - [isObject()](#isobject) - Determines if all entries are objects - [isNumeric()](#isnumeric) - Determines if all entries are numeric values - [isString()](#isstring) - Determines if all entries are string values ### isSole() [](#issole) Tests for the matching item, but is true only if exactly one item is matching. ``` public function isSole( $value = null, $key = null ) : bool ``` - @param **\\Closure|mixed** `$value` Closure with (item, key) parameter or element to test against - @param **string|int|null** `$key` Key to compare the value to if `$value` is not a closure - @return **bool** TRUE if exactly one item matches, FALSE if no or more than one item matches **Examples:** ``` Map::from( ['a', 'b'] )->isSole( 'a' ); // true Map::from( ['a', 'b', 'a'] )->isSole( fn( $v, $k ) => $v === 'a' && $k < 2 ); // true Map::from( [['name' => 'test'], ['name' => 'user']] )->isSole( fn( $v, $k ) => $v['name'] === 'user' ); // true Map::from( ['b', 'c'] )->isSole( 'a' ); // false Map::from( ['a', 'b', 'a'] )->isSole( 'a' ); // false Map::from( [['name' => 'test'], ['name' => 'user'], ['name' => 'test']] )->isSole( 'test', 'name' ); // false ``` **See also:** - \[sole()\]#sole) - Returns only the items matching the value (and key) from the map ### isString() [](#isstring) Determines if all entries are string values. ``` public function isString() : bool ``` - @return **bool** TRUE if all map entries are string values, FALSE if not **Examples:** ``` Map::from( ['abc'] )->isString(); // true Map::from( [] )->isString(); // true Map::from( [1] )->isString(); // false Map::from( [1.1] )->isString(); // false Map::from( [true, false] )->isString(); // false Map::from( [new stdClass] )->isString(); // false Map::from( [resource] )->isString(); // false Map::from( [null] )->isString(); // false Map::from( [[1]] )->isString(); // false ``` **See also:** - [isList()](#islist) - Checks if the map contains a list of subsequentially numbered keys - [isObject()](#isobject) - Determines if all entries are objects - [isNumeric()](#isnumeric) - Determines if all entries are numeric values - [isScalar()](#isscalar) - Determines if all entries are scalar values ### join() [](#join) Concatenates the string representation of all elements. ``` public function join( $glue = '' ) : string ``` - @param **string** `$glue` Character or string added between elements - @return **string** String of concatenated map elements Objects that implement `__toString()` does also work, otherwise (and in case of arrays) a PHP notice is generated. NULL and FALSE values are treated as empty strings. **Examples:** ``` Map::from( ['a', 'b', false] )->join(); // 'ab' Map::from( ['a', 'b', null, false] )->join( '-' ); // 'a-b--' ``` ### jsonSerialize() [](#jsonserialize) Specifies the data which should be serialized to JSON by json\_encode(). ``` public function jsonSerialize() ``` - @return **array<int|string,mixed>** Data to serialize to JSON **Examples:** ``` json_encode( Map::from( ['a', 'b'] ) ); // ["a", "b"] json_encode( Map::from( ['a' => 0, 'b' => 1] ) ); // {"a":0,"b":1} ``` ### keys() [](#keys) Returns the keys of the map elements in a new map object. ``` public function keys() : self ``` - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['a', 'b'] ); // [0, 1] Map::from( ['a' => 0, 'b' => 1] ); // ['a', 'b'] ``` ### krsort() [](#krsort) Sorts the elements by their keys in reverse order. ``` public function krsort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `krsort()` - @return **self<int|string,mixed>** Updated map for fluid interface The parameter modifies how the keys are compared. Possible values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are preserved using this method and no new map is created. **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->krsort(); // ['a' => 1, 'b' => 0] Map::from( [1 => 'a', 0 => 'b'] )->krsort(); // [0 => 'b', 1 => 'a'] ``` **See also:** - [krsorted()](#krsorted) - Sorts a copy of the elements by their keys in reverse order ### krsorted() [](#krsorted) Sorts a copy of the elements by their keys in reverse order. ``` public function krsorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `krsort()` - @return **self<int|string,mixed>** New map The parameter modifies how the keys are compared. Possible values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are preserved using this method and a new map is created. **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->krsorted(); // ['a' => 1, 'b' => 0] Map::from( [1 => 'a', 0 => 'b'] )->krsorted(); // [0 => 'b', 1 => 'a'] ``` **See also:** - [krsort()](#krsort) - Sorts the elements by their keys in reverse order ### krsorted() [](#krsorted-1) Sorts a copy of the elements by their keys in reverse order. ``` public function krsorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `krsort()` - @return **self<int|string,mixed>** Updated map for fluid interface The parameter modifies how the keys are compared. Possible values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are preserved using this method and a new map is created. **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->krsorted(); // ['a' => 1, 'b' => 0] Map::from( [1 => 'a', 0 => 'b'] )->krsorted(); // [0 => 'b', 1 => 'a'] ``` ### ksort() [](#ksort) Sorts the elements by their keys. ``` public function ksort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `ksort()` - @return **self<int|string,mixed>** Updated map for fluid interface The parameter modifies how the keys are compared. Possible values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are preserved using this method and no new map is created. **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->ksort(); // ['a' => 1, 'b' => 0] Map::from( [1 => 'a', 0 => 'b'] )->ksort(); // [0 => 'b', 1 => 'a'] ``` ### ksorted() [](#ksorted) Sorts a copy of the elements by their keys. ``` public function ksorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `ksort()` - @return **self<int|string,mixed>** New map The parameter modifies how the keys are compared. Possible values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are preserved using this method and a new map is created. **Examples:** ``` Map::from( ['b' => 0, 'a' => 1] )->ksorted(); // ['a' => 1, 'b' => 0] Map::from( [1 => 'a', 0 => 'b'] )->ksorted(); // [0 => 'b', 1 => 'a'] ``` ### last() [](#last) Returns the last element from the map. ``` public function last( $default = null ) ``` - @param **mixed** `$default` Default value, closure or exception if the map contains no elements - @return **mixed** Last value of map, (generated) default value or an exception Using this method doesn't affect the internal array pointer. **Examples:** ``` Map::from( ['a', 'b'] )->last(); // 'b' Map::from( [] )->last( 'x' ); // 'x' Map::from( [] )->last( new \Exception( 'error' ) ); // throws \Exception Map::from( [] )->last( function() { return rand(); } ); // random integer ``` **See also:** - [first()](#first) - Returns the first element from the map - [firstKey()](#firstkey) - Returns the key of the first element from the map - [lastKey()](#lastkey) - Returns the key of the last element from the map ### lastKey() [](#lastkey) Returns the key of the last element from the map. ``` public function lastKey( $default = null ) ``` - @param **mixed** `$default` Default value, closure or exception if the map contains no elements - @return **mixed** Last key of map, (generated) default value or an exception Using this method doesn't affect the internal array pointer. **Examples:** ``` Map::from( ['a' => 1, 'b' => 2] )->lastKey(); // 'b' Map::from( [] )->lastKey( 'x' ); // 'x' Map::from( [] )->lastKey( new \Exception( 'error' ) ); // throws \Exception Map::from( [] )->lastKey( function() { return rand(); } ); // random integer ``` **See also:** - [first()](#first) - Returns the first element from the map - [firstKey()](#firstkey) - Returns the key of the first element from the map - [last()](#last) - Returns the last element from the map ### ltrim() [](#ltrim) Removes the passed characters from the left of all strings. ``` public function ltrim( string $chars = " \n\r\t\v\x00" ) : self ``` - @param **string** `$chars` List of characters to trim - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( [" abc\n", "\tcde\r\n"] )->ltrim(); // ["abc\n", "cde\r\n"] Map::from( ["a b c", "cbxa"] )->ltrim( 'abc' ); // [" b c", "xa"] ``` **See also:** - [ltrim()](#ltrim) - Removes the passed characters from the left of all strings - [rtrim()](#rtrim) - Removes the passed characters from the right of all strings - [trim()](#trim) - Removes the passed characters from the left/right of all strings ### map() [](#map) Maps new values to the existing keys using the passed function and returns a new map for the result. ``` public function map( callable $callback ) : self ``` - @param **callable** `$callback` Function with (value, key) parameters and returns computed result - @return **self<int|string,mixed>** New map with the original keys and the computed values The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 2, 'b' => 4] )->map( function( $value, $key ) { return $value * 2; } ); // ['a' => 4, 'b' => 8] ``` **See also:** - [col()](#col) - Returns the values of a single column/property from an array of arrays or list of elements in a new map - [pluck()](#pluck) - Creates a key/value mapping (alias) - [rekey()](#pluck) - Changes the keys according to the passed function ### max() [](#max) Returns the maximum value of all elements. ``` public function max( $col = null ) ``` - @param **Closure|string|null** `$col` Closure, key in the nested array or object to check for - @return **mixed** Maximum value or NULL if there are no elements in the map NULL values are removed before the comparison. If there are no values or all values are NULL, NULL is returned. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. Be careful comparing elements of different types because this can have unpredictable results due to the [PHP comparison rules](https://www.php.net/manual/en/language.operators.comparison.php) **Examples:** ``` Map::from( [1, 3, 2, 5, 4] )->max(); // 5 Map::from( ['bar', 'foo', 'baz'] )->max(); // 'foo' Map::from( [['p' => 30], ['p' => 50], ['p' => 10]] )->max( 'p' ); // 50 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->max( 'i/p' ); // 50 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->max( fn( $val, $key ) => $val['i']['p'] ?? null ) // 50 Map::from( [50, 10, 30] )->max( fn( $val, $key ) => $key > 0 ? $val : null ) // 30 ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [count()](#count) - Returns the total number of elements - [min()](#min) - Returns the minium value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test - [sum()](#sum) - Returns the sum of all values in the map ### merge() [](#merge) Merges the map with the given elements without returning a new map. ``` public function merge( iterable $elements, bool $recursive = false ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **bool** `$recursive` TRUE to merge nested arrays too, FALSE for first level elements only - @return **self<int|string,mixed>** Updated map for fluid interface Elements with the same non-numeric keys will be overwritten, elements with the same numeric keys will be added. The method is similar to [replace()](#replace) but doesn't replace elements with the same numeric keys. If you want to be sure that all passed elements are added without replacing existing ones, use [concat()](#concat) instead. The keys are preserved using this method. **Examples:** ``` Map::from( ['a', 'b'] )->merge( ['b', 'c'] ); // ['a', 'b', 'b', 'c'] Map::from( ['a' => 1, 'b' => 2] )->merge( ['b' => 4, 'c' => 6] ); // ['a' => 1, 'b' => 4, 'c' => 6] Map::from( ['a' => 1, 'b' => 2] )->merge( ['b' => 4, 'c' => 6], true ); // ['a' => 1, 'b' => [2, 4], 'c' => 6] ``` **See also:** - [concat()](#combine) - Adds all elements with new keys - [union()](#union) - Builds a union of the elements and the given elements without returning a new map ### method() [](#method) Registers a custom method or returns the existing one. ``` public static function method( string $method, \Closure $fcn = null ) : ?\Closure ``` - @param **string** `$method` Method name - @param **\\Closure|null** `$fcn` Anonymous function or NULL to return the closure if available - @return **\\Closure|null** Registered anonymous function or NULL if none has been registered The registed method has access to the class properties if called non-static. **Examples:** ``` Map::method( 'foo', function( $arg1, $arg2 ) { return array_merge( $this->elements, [$arg1, $arg2] ); } ); Map::method( 'foo' ); // registered closure Map::method( 'foo2' ); // NULL Map::from( ['bar'] )->foo( 'foo', 'baz' ); // ['bar', 'foo', 'baz'] Map::foo( 'foo', 'baz' ); // error because `$this->elements` isn't available ``` Static calls can't access `$this->elements` but can operate on the parameter values: ``` Map::method( 'bar', function( $arg1, $arg2 ) { return new static( [$arg1, $arg2] ); } ); Map::foo( 'foo', 'baz' ); // ['foo', 'baz'] ``` ### min() [](#min) Returns the minimum value of all elements. ``` public function min( $col = null ) ``` - @param **Closure|string|null** `$col` Closure, key in the nested array or object to check for - @return **mixed** Minimum value or NULL if there are no elements in the map NULL values are removed before the comparison. If there are no values or all values are NULL, NULL is returned. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. Be careful comparing elements of different types because this can have unpredictable results due to the [PHP comparison rules](https://www.php.net/manual/en/language.operators.comparison.php) **Examples:** ``` Map::from( [2, 3, 1, 5, 4] )->min(); // 1 Map::from( ['baz', 'foo', 'bar'] )->min(); // 'bar' Map::from( [['p' => 30], ['p' => 50], ['p' => 10]] )->min( 'p' ); // 10 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->min( 'i/p' ); // 30 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->min( fn( $val, $key ) => $val['i']['p'] ?? null ) // 30 Map::from( [10, 50, 30] )->min( fn( $val, $key ) => $key > 0 ? $val : null ) // 30 ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [count()](#count) - Returns the total number of elements - [max()](#max) - Returns the maximum value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test - [sum()](#sum) - Returns the sum of all values in the map ### none() [](#none) Tests if none of the elements are part of the map. ``` public function none( $element, bool $strict = false ) : bool ``` - @param **mixed|array** `$element` Element or elements to search for in the map - @param **bool** `$strict` TRUE to check the type too, using FALSE '1' and 1 will be the same - @return **bool** TRUE if none of the elements is part of the map, FALSE if at least one is **Examples:** ``` Map::from( ['a', 'b'] )->none( 'x' ); // true Map::from( ['1', '2'] )->none( 2, true ); // true Map::from( ['a', 'b'] )->none( 'a' ); // false Map::from( ['a', 'b'] )->none( ['a', 'b'] ); // false Map::from( ['a', 'b'] )->none( ['a', 'x'] ); // false ``` **See also:** - [contains()](#contains) - Tests if an item exists in the map - [includes()](#includes) - Tests if element is included - [in()](#in) - Tests if element is included ### nth() [](#nth) Returns every nth element from the map. ``` public function nth( int $step, int $offset = 0 ) : self ``` - @param **int** `$step` Step width - @param **int** `$offset` Number of element to start from (0-based) - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( ['a', 'b', 'c', 'd', 'e', 'f'] )->nth( 2 ); // ['a', 'c', 'e'] Map::from( ['a', 'b', 'c', 'd', 'e', 'f'] )->nth( 2, 1 ); // ['b', 'd', 'f'] ``` ### offsetExists() [](#offsetexists) Determines if an element exists at an offset. ``` public function offsetExists( $key ) ``` - @param **int|string** `$key` Key to check for - @return **bool** TRUE if key exists, FALSE if not **Examples:** ``` $map = Map::from( ['a' => 1, 'b' => 3, 'c' => null] ); isset( $map['b'] ); // true isset( $map['c'] ); // false isset( $map['d'] ); // false ``` **See also:** - [offsetGet()](#offsetget) - Returns an element at a given offset - [offsetSet()](#offsetset) - Sets the element at a given offset - [offsetUnset()](#offsetunset) - Unsets the element at a given offset ### offsetGet() [](#offsetget) Returns an element at a given offset. ``` public function offsetGet( $key ) ``` - @param **int|string** `$key` Key to return the element for - @return **mixed** Value associated to the given key **Examples:** ``` $map = Map::from( ['a' => 1, 'b' => 3] ); $map['b']; // 3 ``` **See also:** - [offsetExists()](#offsetexists) - Determines if an element exists at an offset. - [offsetSet()](#offsetset) - Sets the element at a given offset - [offsetUnset()](#offsetunset) - Unsets the element at a given offset ### offsetSet() [](#offsetset) Sets the element at a given offset. ``` public function offsetSet( $key, $value ) ``` - @param **int|string|null** `$key` Key to set the element for or NULL to append value - @param **mixed** `$value` New value set for the key **Examples:** ``` $map = Map::from( ['a' => 1] ); $map['b'] = 2; // ['a' => 1, 'b' => 2] $map[0] = 4; // ['a' => 1, 'b' => 2, 0 => 4] ``` **See also:** - [offsetExists()](#offsetexists) - Determines if an element exists at an offset. - [offsetGet()](#offsetget) - Returns an element at a given offset - [offsetUnset()](#offsetunset) - Unsets the element at a given offset ### offsetUnset() [](#offsetunset) Unsets the element at a given offset. ``` public function offsetUnset( $key ) ``` - @param **int|string** `$key` Key for unsetting the item **Examples:** ``` $map = Map::from( ['a' => 1] ); unset( $map['a'] ); // [] ``` **See also:** - [offsetExists()](#offsetexists) - Determines if an element exists at an offset. - [offsetGet()](#offsetget) - Returns an element at a given offset - [offsetSet()](#offsetset) - Sets the element at a given offset ### only() [](#only) Returns a new map with only those elements specified by the given keys. ``` public function only( $keys ) : self ``` - @param **iterable<mixed>|array<mixed>|string|int** `$keys` Keys of the elements that should be returned - @return **self<int|string,mixed>** New map with only the elements specified by the keys The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 1, 0 => 'b'] )->only( 'a' ); // ['a' => 1] Map::from( ['a' => 1, 0 => 'b', 1 => 'c'] )->only( [0, 1] ); // [0 => 'b', 1 => 'c'] ``` **See also:** - [clear()](#clear) - Removes all elements from the current map - [except()](#except) - Returns a new map without the passed element keys - [reject()](#reject) - Removes all matched elements - [remove()](#remove) - Removes an element by key ### order() [](#order) Returns a new map with elements ordered by the passed keys. ``` public function order( iterable $keys ) : self ``` - @param **iterable<mixed>** `$keys` Keys of the elements in the required order - @return **self<int|string,mixed>** New map with elements ordered by the passed keys The keys are preserved using this method. **Examples:** ``` Map::from( ['a' => 1, 1 => 'c', 0 => 'b'] )->order( [0, 1, 'a'] ); // [0 => 'b', 1 => 'c', 'a' => 1] Map::from( ['a' => 1, 1 => 'c', 0 => 'b'] )->order( [0, 1, 2] ); // [0 => 'b', 1 => 'c', 2 => null] Map::from( ['a' => 1, 1 => 'c', 0 => 'b'] )->order( [0, 1] ); // [0 => 'b', 1 => 'c'] ``` ### pad() [](#pad) Fill up to the specified length with the given value ``` public function pad( int $size, $value = null ) : self ``` - @param **int** `$size` Total number of elements that should be in the list - @param **mixed** `$value` Value to fill up with if the map length is smaller than the given size - @return **self<int|string,mixed>** Updated map for fluid interface In case the given number is smaller than the number of element that are already in the list, the map is unchanged. If the size is positive, the new elements are padded on the right, if it's negative then the elements are padded on the left. Associative keys are preserved, numerical keys are replaced and numerical keys are used for the new elements. **Examples:** ``` Map::from( [1, 2, 3] )->pad( 5 ); // [1, 2, 3, null, null] Map::from( [1, 2, 3] )->pad( -5 ); // [null, null, 1, 2, 3] Map::from( [1, 2, 3] )->pad( 5, '0' ); // [1, 2, 3, '0', '0'] Map::from( [1, 2, 3] )->pad( 2 ); // [1, 2, 3] Map::from( [10 => 1, 20 => 2] )->pad( 3 ); // [0 => 1, 1 => 2, 2 => null] Map::from( ['a' => 1, 'b' => 2] )->pad( 3, 3 ); // ['a' => 1, 'b' => 2, 0 => 3] ``` ### partition() [](#partition) Breaks the list of elements into the given number of groups. ``` public function partition( $num ) : self ``` - @param **\\Closure|int** `$number` Function with (value, index) as arguments returning the bucket key or number of groups - @return **self<int|string,mixed>** New map The keys of the original map are preserved in the returned map. **Examples:** ``` Map::from( [1, 2, 3, 4, 5] )->partition( 3 ); // [[0 => 1, 1 => 2], [2 => 3, 3 => 4], [4 => 5]] Map::from( [1, 2, 3, 4, 5] )->partition( function( $val, $idx ) { return $idx % 3; } ); // [0 => [0 => 1, 3 => 4], 1 => [1 => 2, 4 => 5], 2 => [2 => 3]] ``` **See also:** - [chunk()](#chunk) - Chunks the map into arrays with the given number of elements ### percentage() [](#percentage) Returns the percentage of all elements passing the test in the map. ``` public function percentage( \Closure $fcn, int $precision = 2 ) : float ``` - @param **\\Closure** `$fcn` Closure to filter the values in the nested array or object to compute the percentage - @param **int** `$precision` Number of decimal digits use by the result value - @return **float** Percentage of all elements passing the test in the map **Examples:** ``` Map::from( [30, 50, 10] )->percentage( fn( $val, $key ) => $val < 50 ); // 66.67 Map::from( [] )->percentage( fn( $val, $key ) => true ); // 0.0 Map::from( [30, 50, 10] )->percentage( fn( $val, $key ) => $val > 100 ); // 0.0 Map::from( [30, 50, 10] )->percentage( fn( $val, $key ) => $val > 30, 3 ); // 33.333 Map::from( [30, 50, 10] )->percentage( fn( $val, $key ) => $val > 30, 0 ); // 33.0 Map::from( [30, 50, 10] )->percentage( fn( $val, $key ) => $val < 50, -1 ); // 70.0 ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [count()](#count) - Returns the total number of elements - [max()](#max) - Returns the maximum value of all elements - [min()](#min) - Returns the minium value of all elements - [sum()](#sum) - Returns the sum of all values in the map ### pipe() [](#pipe) Passes the map to the given callback and return the result. ``` public function pipe( \Closure $callback ) ``` - @param **\\Closure** `$callback` Function with map as parameter which returns arbitrary result - @return **mixed** Result returned by the callback **Examples:** ``` Map::from( ['a', 'b'] )->pipe( function( $map ) { return strrev( $map->join( '-' ) ); } ); // 'b-a' ``` ### pluck() [](#pluck) Returns the values of a single column/property from an array of arrays or list of elements in a new map (alias). ``` public function pluck( string $valuecol = null, string $indexcol = null ) : self ``` - @param **string|null** `$valuecol` Name or path of the value property - @param **string|null** `$indexcol` Name or path of the index property - @return **self<int|string,mixed>** New map with mapped entries This method is an alias for [col()](#col). For performance reasons, `col()` should be preferred because it uses one method call less than `pluck()`. **See also:** - [col()](#col) - Returns the values of a single column/property from an array of arrays or list of elements in a new map - [map()](#map) - Applies a callback to each element and returns the results - [pluck()](#pluck) - Creates a key/value mapping (alias) - [rekey()](#pluck) - Changes the keys according to the passed function ### pop() [](#pop) Returns and removes the last element from the map. ``` public function pop() ``` - @return **mixed** Last element of the map or null if empty **Examples:** ``` Map::from( ['a', 'b'] )->pop(); // 'b', map contains ['a'] ``` **See also:** - [push()](#push) - Adds an element onto the end of the map without returning a new map ### pos [](#pos) Returns the numerical index of the value. ``` public function pos( $value ) : ?int ``` - @param **\\Closure|mixed** `$value` Value to search for or function with (item, key) parameters return TRUE if value is found - @return **int|null** Position of the found value (zero based) or NULL if not found **Examples:** ``` Map::from( [4 => 'a', 8 => 'b'] )->pos( 'b' ); // 1 Map::from( [4 => 'a', 8 => 'b'] )->pos( function( $item, $key ) { return $item === 'b'; } ); // 1 ``` Both examples will return "1" because the value "b" is at the second position and the returned index is zero based so the first item has the index "0". **See also:** - [at()](#at) - Returns the value at the given position - [index()](#index) - Returns the numerical index of the given key ### prefix [](#prefix) Adds a prefix in front of each map entry. ``` public function prefix( $prefix, int $depth = null ) : self ``` - @param **\\Closure|string** `$prefix` Function with map as parameter which returns arbitrary result - @param **int|null** `$depth` Maximum depth to dive into multi-dimensional arrays starting from "1" - @return **self<int|string,mixed>** Updated map for fluid interface By default, nested arrays are walked recusively so all entries at all levels are prefixed. The keys of the original map are preserved in the returned map. **Examples:** ``` Map::from( ['a', 'b'] )->prefix( '1-' ); // ['1-a', '1-b'] Map::from( ['a', ['b']] )->prefix( '1-' ); // ['1-a', ['1-b']] Map::from( ['a', ['b']] )->prefix( '1-', 1 ); // ['1-a', ['b']] Map::from( ['a', 'b'] )->prefix( function( $item, $key ) { return ( ord( $item ) + ord( $key ) ) . '-'; } ); // ['145-a', '147-b'] ``` **See also:** - [suffix()](#suffix) - Adds a suffix at the end of each map entry ### prepend() [](#prepend) Pushes an element onto the beginning of the map without returning a new map (alias). ``` public function prepend( $value, $key = null ) : self ``` - @param **mixed** `$value` Item to add at the beginning - @param **int|string|null** `$key` Key for the item or NULL to reindex all numerical keys - @return **self<int|string,mixed>** Updated map for fluid interface This method is an alias for the [unshift()](#unshift) method. For performance reasons, `unshift()` should be preferred because it uses one method call less than `prepend()`. **See also:** - [unshift()](#unshift) - Underlying method with same parameters and return value but better performance ### pull() [](#pull) Returns and removes an element from the map by its key. ``` public function pull( $key, $default = null ) ``` - @param **int|string** `$key` Key to retrieve the value for - @param **mixed** `$default` Default value if key isn't available - @return **mixed** Value from map or default value **Examples:** ``` Map::from( ['a', 'b', 'c'] )->pull( 1 ); // 'b', map contains ['a', 'c'] Map::from( ['a', 'b', 'c'] )->pull( 'x', 'none' ); // 'none', map contains ['a', 'b', 'c'] ``` **See also:** - [get()](#get) - Returns an element from the map by key ### push() [](#push) Adds an element onto the end of the map without returning a new map. ``` public function push( $value ) : self ``` - @param **mixed** `$value` Value to add to the end - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['a', 'b'] )->push( 'aa' ); // ['a', 'b', 'aa'] ``` **See also:** - [pop()](#pop) - Returns and removes the last element from the map ### put() [](#put) Sets the given key and value in the map without returning a new map (alias). ``` public function put( $key, $value ) : self ``` - @param **int|string** `$key` Key to set the new value for - @param **mixed** `$value` New element that should be set - @return **self<int|string,mixed>** Updated map for fluid interface This method is an alias for [set()](#set). For performance reasons, `set()` should be preferred because it uses one method call less than `put()`. **See also:** - [set()](#set) - Underlying method with same parameters and return value but better performance ### random() [](#random) Returns one or more random element from the map. ``` public function random( int $max = 1 ) : self ``` - @param **int** `$max` Maximum number of elements that should be returned - @return **self<int|string,mixed>** New map with key/element pairs from original map in random order - @throws **\\InvalidArgumentException** If requested number of elements is less than 1 The less elements are in the map, the less random the order will be, especially if the maximum number of values is high or close to the number of elements. The keys of the original map are preserved in the returned map. **Examples:** ``` Map::from( [2, 4, 8, 16] )->random(); // [2 => 8] or any other key/value pair Map::from( [2, 4, 8, 16] )->random( 2 ); // [3 => 16, 0 => 2] or any other key/value pair Map::from( [2, 4, 8, 16] )->random( 5 ); // [0 => 2, 1 => 4, 2 => 8, 3 => 16] in random order ``` ### reduce() [](#reduce) Iteratively reduces the array to a single value using a callback function. ``` public function reduce( callable $callback, $initial = null ) ``` - @param **callable** `$callback` Function with (result, value) parameters and returns result - @param **mixed** `$initial` Initial value when computing the result - @return **mixed** Value computed by the callback function Afterwards, the map will be empty. **Examples:** ``` Map::from( [2, 8] )->reduce( function( $result, $value ) { return $result += $value; }, 10 ); // 20 because 10 + 2 + 8 and map equals [] ``` ### reject() [](#reject) Removes all matched elements and returns a new map. ``` public function reject( $callback = true ) : self ``` - @param **Closure|mixed** `$callback` Function with (item) parameter which returns TRUE/FALSE or value to compare with - @return **self<int|string,mixed>** New map This method is the inverse of the [filter()](#filter) and should return TRUE if the item should be removed from the returned map. If no callback is passed, all values which are NOT empty, null or false will be removed. The keys of the original map are preserved in the returned map. **Examples:** ``` Map::from( [2 => 'a', 6 => 'b', 13 => 'm', 30 => 'z'] )->reject( function( $value, $key ) { return $value < 'm'; } ); // [13 => 'm', 30 => 'z'] Map::from( [2 => 'a', 13 => 'm', 30 => 'z'] )->reject( 'm' ); // [2 => 'a', 30 => 'z'] Map::from( [2 => 'a', 6 => null, 13 => 'm'] )->reject(); // [6 => null] ``` **See also:** - [clear()](#clear) - Removes all elements from the current map - [duplicates()](#duplicates) - Returns the duplicate values from the map - [except()](#except) - Returns a new map without the passed element keys - [only()](#only) - Returns only those elements specified by the keys - [remove()](#remove) - Removes an element by key ### rekey() [](#rekey) Changes the keys according to the passed function. ``` public function rekey( callable $callback ) : self ``` - @param **callable** `$callback` Function with (value, key) parameters and returns new key - @return **self<int|string,mixed>** New map with new keys and original values **Examples:** ``` Map::from( ['a' => 2, 'b' => 4] )->rekey( function( $value, $key ) { return 'key-' . $key; } ); // ['key-a' => 2, 'key-b' => 4] ``` **See also:** - [map()](#map) - Maps new values to the existing keys using the passed function and returns a new map for the result - [transform()](#transform) - Creates new key/value pairs using the passed function and returns a new map for the result ### remove() [](#remove) Removes one or more elements from the map by its keys without returning a new map. ``` public function remove( $keys ) : self ``` - @param **iterable<int|string>|array<int|string>|string|int** `$keys` List of keys - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['a' => 1, 2 => 'b'] )->remove( 'a' ); // [2 => 'b'] Map::from( ['a' => 1, 2 => 'b'] )->remove( [2, 'a'] ); // [] ``` **See also:** - [clear()](#clear) - Removes all elements from the current map - [except()](#except) - Returns a new map without the passed element keys - [only()](#only) - Returns only those elements specified by the keys - [reject()](#reject) - Removes all matched elements ### replace() [](#replace) Replaces elements in the map with the given elements without returning a new map. ``` public function replace( iterable $elements, bool $recursive = true ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @param **bool** `$recursive` TRUE to replace recursively (default), FALSE to replace elements only - @return **self<int|string,mixed>** Updated map for fluid interface The method is similar to [merge()](#merge) but also replaces elements with numeric keys. These would be added by `merge()` with a new numeric key. The keys are preserved in the returned map. **Examples:** ``` Map::from( ['a' => 1, 2 => 'b'] )->replace( ['a' => 2] ); // ['a' => 2, 2 => 'b'] Map::from( ['a' => 1, 'b' => ['c' => 3, 'd' => 4]] )->replace( ['b' => ['c' => 9]] ); // ['a' => 1, 'b' => ['c' => 9, 'd' => 4]] ``` ### restrict() [](#restrict) Returns only the items matching the value (and key) from the map. ``` public function restrict( $value = null, $key = null ) : self ``` - @param **\\Closure|mixed** `$value` Closure with (item, key) parameter or element to test against - @param **string|int|null** `$key` Key to compare the value to if `$value` is not a closure - @return **self<int|string,mixed>** New map with matching items only The keys are preserved in the returned map. **Examples:** ``` Map::from( ['a', 'b', 'a'] )->restrict( 'a' ); // [0 => 'a', 2 => 'a'] Map::from( [['name' => 'test'], ['name' => 'user'], ['name' => 'test']] )->restrict( 'test', 'name' ); // [0 => ['name' => 'test'], 2 => ['name' => 'test']] Map::from( [['name' => 'test'], ['name' => 'user']] )->restrict( fn( $v, $k ) => $v['name'] === 'user' ); // [1 => ['name' => 'user']] Map::from( ['a', 'b', 'a'] )->restrict( fn( $v, $k ) => $v === 'a' && $k < 2 ); // [0 => 'a'] ``` **See also:** - [filter()](#filter) - Applies a filter to all elements - [only()](#only) - Returns only those elements specified by the keys - \[where()\]#where) - Filters the list of elements by a given condition ### reverse() [](#reverse) Reverses the element order without returning a new map. ``` public function reverse() : self ``` - @return **self<int|string,mixed>** Updated map for fluid interface The keys are preserved using this method. **Examples:** ``` Map::from( ['a', 'b'] )->reverse(); // ['b', 'a'] Map::from( ['name' => 'test', 'last' => 'user'] )->reverse(); // ['last' => 'user', 'name' => 'test'] ``` **See also:** - [reversed()](#reversed) - Reverses the element order in a copy of the map ### reversed() [](#reversed) Reverses the element order in a copy of the map. ``` public function reversed() : self ``` - @return **self<int|string,mixed>** New map with a reversed copy of the elements The keys are preserved using this method and a new map is created before reversing the elements. Thus, [reverse()](#reverse) should be preferred for performance reasons if possible. **Examples:** ``` Map::from( ['a', 'b'] )->reversed(); // ['b', 'a'] Map::from( ['name' => 'test', 'last' => 'user'] )->reversed(); // ['last' => 'user', 'name' => 'test'] ``` **See also:** - [reverse()](#reverse) - Reverses the element order without returning a new map ### rsort() [](#rsort) Sorts all elements in reverse order without maintaining the key association. ``` public function rsort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `rsort()` - @return **self<int|string,mixed>** Updated map for fluid interface The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are NOT preserved and elements get a new index. No new map is created. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->rsort(); // [0 => 1, 1 => 0] Map::from( [0 => 'b', 1 => 'a'] )->rsort(); // [0 => 'b', 1 => 'a'] Map::from( [0 => 'C', 1 => 'b'] )->rsort(); // [0 => 'b', 1 => 'C'] Map::from( [0 => 'C', 1 => 'b'] )->rsort( SORT_STRING|SORT_FLAG_CASE ); // [0 => 'C', 1 => 'b'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [rsorted()](#rsorted) - Sorts a copy of all elements in reverse order without maintaining the key association ### rsorted() [](#rsorted) Sorts a copy of all elements in reverse order without maintaining the key association. ``` public function rsorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for `rsort()` - @return **self<int|string,mixed>** New map The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are NOT preserved, elements get a new index and a new map is created. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->rsorted(); // [0 => 1, 1 => 0] Map::from( [0 => 'b', 1 => 'a'] )->rsorted(); // [0 => 'b', 1 => 'a'] Map::from( [0 => 'C', 1 => 'b'] )->rsorted(); // [0 => 'b', 1 => 'C'] Map::from( [0 => 'C', 1 => 'b'] )->rsorted( SORT_STRING|SORT_FLAG_CASE ); // [0 => 'C', 1 => 'b'] because 'C' -> 'c' and 'c' > 'b' ``` **See also:** - [rsort()](#rsort) - Sorts all elements in reverse order without maintaining the key association ### rtrim() [](#rtrim) Removes the passed characters from the right of all strings. ``` public function rtrim( string $chars = " \n\r\t\v\x00" ) : self ``` - @param **string** `$chars` List of characters to trim - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( [" abc\n", "\tcde\r\n"] )->rtrim(); // [" abc", "\tcde"] Map::from( ["a b c", "cbxa"] )->rtrim( 'abc' ); // ["a b ", "cbx"] ``` **See also:** - [ltrim()](#ltrim) - Removes the passed characters from the left of all strings - [trim()](#trim) - Removes the passed characters from the left/right of all strings ### search() [](#search) Searches the map for a given value and return the corresponding key if successful. ``` public function search( $value, $strict = true ) ``` - @param **mixed** `$value` Item to search for - @param **bool** `$strict` TRUE if type of the element should be checked too - @return **int|string|null** Key associated to the value or null if not found **Examples:** ``` Map::from( ['a', 'b', 'c'] )->search( 'b' ); // 1 Map::from( [1, 2, 3] )->search( '2', true ); // null because the types doesn't match (int vs. string) ``` ### sep() [](#sep) Sets the seperator for paths to values in multi-dimensional arrays or objects. ``` public static function sep( string $char ) : self ``` - @param **string** `$char` Separator character, e.g. "." for "key.to.value" instead of "key/to/value" - @return **self<int|string,mixed>** Same map for fluid interface This method only changes the separator for the current map instance. To change the separator for all maps created afterwards, use the static [Map::delimiter()](#delimiter) method instead. **Examples:** ``` Map::from( ['foo' => ['bar' => 'baz']] )->sep( '.' )->get( 'foo.bar' ); // 'baz' ``` **See also:** - [delimiter()](#delimiter) - Sets or returns the seperator for paths to values in multi-dimensional arrays or objects ### set() [](#set) Sets an element in the map by key without returning a new map. ``` public function set( $key, $value ) : self ``` - @param **int|string** `$key` Key to set the new value for - @param **mixed** `$value` New element that should be set - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['a'] )->set( 1, 'b' ); // [0 => 'a', 1 => 'b'] Map::from( ['a'] )->set( 0, 'b' ); // [0 => 'b'] ``` **See also:** - [get()](#get) - Returns an element from the map by key - [with()](#with) - Returns a copy of the map with the element at the given index replaced with the given value ### shift() [](#shift) Returns and removes the first element from the map. ``` public function shift() ``` - @return **mixed|null** Value from map or null if not found **Examples:** ``` Map::from( ['a', 'b'] )->shift(); // 'a' Map::from( [] )->shift(); // null ``` **Performance note:** The bigger the list, the higher the performance impact because `shift()`reindexes all existing elements. Usually, it's better to [reverse()](#reverse)the list and [pop()](#pop) entries from the list afterwards if a significant number of elements should be removed from the list: ``` $map->reverse()->pop(); ``` instead of ``` $map->shift(); ``` **See also:** - [unshift()](#unshift) - Pushes an element onto the beginning of the map without returning a new map ### shuffle() [](#shuffle) Shuffles the elements in the map without returning a new map. ``` public function shuffle( bool $assoc = false ) : self ``` - @param **bool** `$assoc` True to preserve keys, false to assign new keys - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( [2 => 'a', 4 => 'b'] )->shuffle(); // ['a', 'b'] in random order with new keys Map::from( [2 => 'a', 4 => 'b'] )->shuffle( true ); // [2 => 'a', 4 => 'b'] in random order with keys preserved ``` **See also:** - [shuffled()](#shuffled) - Shuffles the elements in a copy of the map. ### shuffled() [](#shuffled) Shuffles the elements in a copy of the map. ``` public function shuffled( bool $assoc = false ) : self ``` - @param **bool** `$assoc` True to preserve keys, false to assign new keys - @return **self<int|string,mixed>** New map with a shuffled copy of the elements **Examples:** ``` Map::from( [2 => 'a', 4 => 'b'] )->shuffled(); // ['a', 'b'] in random order with new keys Map::from( [2 => 'a', 4 => 'b'] )->shuffled( true ); // [2 => 'a', 4 => 'b'] in random order with keys preserved ``` **See also:** - [shuffle()](#shuffle) - Shuffles the elements in the map without returning a new map ### skip() [](#skip) Returns a new map with the given number of items skipped. ``` public function skip( $offset ) : self ``` - @param **\\Closure|int** `$offset` Number of items to skip or function($item, $key) returning true for skipped items - @return **self<int|string,mixed>** New map The keys of the items returned in the new map are the same as in the original one. **Examples:** ``` Map::from( [1, 2, 3, 4] )->skip( 2 ); // [2 => 3, 3 => 4] Map::from( [1, 2, 3, 4] )->skip( function( $item, $key ) { return $item < 4; } ); // [3 => 4] ``` ### slice() [](#slice) Returns a map with the slice from the original map. ``` public function slice( int $offset, int $length = null ) : self ``` - @param **int** `$offset` Number of elements to start from - @param **int|null** `$length` Number of elements to return or NULL for no limit - @return **self<int|string,mixed>** New map The rules for offsets are: - If offset is non-negative, the sequence will start at that offset - If offset is negative, the sequence will start that far from the end Similar for the length: - If length is given and is positive, then the sequence will have up to that many elements in it - If the array is shorter than the length, then only the available array elements will be present - If length is given and is negative then the sequence will stop that many elements from the end - If it is omitted, then the sequence will have everything from offset up until the end The keys of the items returned in the new map are the same as in the original one. **Examples:** ``` Map::from( ['a', 'b', 'c'] )->slice( 1 ); // ['b', 'c'] Map::from( ['a', 'b', 'c'] )->slice( 1, 1 ); // ['b'] Map::from( ['a', 'b', 'c', 'd'] )->slice( -2, -1 ); // ['c'] ``` **See also:** - [take()](#take) - Returns a new map with the given number of items. ### sliding() [](#sliding) Returns a new map containing sliding windows of the original map. ``` public function sliding( int $size = 2, int $step = 1 ) : self ``` - @param **int** $size Size of each window - @param **int** $step Step size to move the window - @return **self<int,array<int|string,mixed>>** New map containing arrays for each window **Examples:** ``` Map::from( [1, 2, 3, 4] )->sliding( 2 ); // [ // [0 => 1, 1 => 2], // [1 => 2, 2 => 3], // [2 => 3, 3 => 4] // ] Map::from( [1, 2, 3, 4] )->sliding( 3, 2 ); // [ // [0 => 1, 1 => 2, 2 => 3], // [2 => 3, 3 => 4, 4 => 5] // ] ``` ### sole() [](#sole) Returns the matching item, but only if one matching item exists. ``` public function sole( $value = null, $key = null ) ``` - @param **\\Closure|mixed** `$value` Closure with (item, key) parameter or element to test against - @param **string|int|null** `$key` Key to compare the value to if `$value` is not a closure - @return **mixed** Value from map if exactly one matching item exists - @throws **\\LengthException** If no items or more than one item is found The keys are preserved in the returned map. **Examples:** ``` Map::from( ['a', 'b'] )->sole( 'a' ); // "a" Map::from( ['a', 'b', 'a'] )->restrict( fn( $v, $k ) => $v === 'a' && $k < 2 ); // "a" Map::from( [['name' => 'test'], ['name' => 'user']] )->restrict( fn( $v, $k ) => $v['name'] === 'user' ); // [['name' => 'user']] Map::from( ['b', 'c'] )->sole( 'a' ); // LengthException Map::from( ['a', 'b', 'a'] )->sole( 'a' ); // LengthException Map::from( [['name' => 'test'], ['name' => 'user'], ['name' => 'test']] )->restrict( 'test', 'name' ); // LengthException ``` **See also:** - \[isSole()\]#issole) - Tests for the matching item, but is true only if exactly one item is matching - \[restrict()\]#restrict) - Returns only the items matching the value (and key) from the map ### some() [](#some) Tests if at least one element passes the test or is part of the map. ``` public function some( $values, bool $strict = false ) : bool ``` - @param **\\Closure|iterable|mixed** `$values` Anonymous function with (item, key) parameter, element or list of elements to test against - @param **bool** `$strict` TRUE to check the type too, using FALSE '1' and 1 will be the same - @return **bool** TRUE if at least one element is available in map, FALSE if the map contains none of them **Examples:** ``` Map::from( ['a', 'b'] )->some( 'a' ); // true Map::from( ['a', 'b'] )->some( ['a', 'c'] ); // true Map::from( ['a', 'b'] )->some( function( $item, $key ) { return $item === 'a' } ); // true Map::from( ['a', 'b'] )->some( ['c', 'd'] ); // false Map::from( ['1', '2'] )->some( [2], true ); // false ``` **See also:** - [every()](#every) - Verifies that all elements pass the test of the given callback - [any()](#any) - Tests if at least one element satisfies the callback function ### sort() [](#sort) Sorts all elements without maintaining the key association. ``` public function sort( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for PHP `sort()` - @return **self<int|string,mixed>** Updated map for fluid interface The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys are NOT preserved and elements get a new index. No new map is created. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->sort(); // [0 => 0, 1 => 1] Map::from( [0 => 'b', 1 => 'a'] )->sort(); // [0 => 'a', 1 => 'b'] ``` **See also:** - [sorted()](#sorted) - Sorts a copy of the elements using new keys ### sorted() [](#sorted) Sorts a copy of the elements using new keys. ``` public function sorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for PHP `sort()` - @return **self<int|string,mixed>** New map The parameter modifies how the values are compared. Possible parameter values are: - SORT\_REGULAR : compare elements normally (don't change types) - SORT\_NUMERIC : compare elements numerically - SORT\_STRING : compare elements as strings - SORT\_LOCALE\_STRING : compare elements as strings, based on the current locale or changed by `setlocale()` - SORT\_NATURAL : compare elements as strings using "natural ordering" like `natsort()` - SORT\_FLAG\_CASE : use SORT\_STRING|SORT\_FLAG\_CASE and SORT\_NATURAL|SORT\_FLAG\_CASE to sort strings case-insensitively The keys aren't preserved and elements get a new index and a new map is created before sorting the elements. Thus, [sort()](#sort) should be preferred for performance reasons if possible. A new map is created by calling this method. **Examples:** ``` Map::from( ['a' => 1, 'b' => 0] )->sorted(); // [0 => 0, 1 => 1] Map::from( [0 => 'b', 1 => 'a'] )->sorted(); // [0 => 'a', 1 => 'b'] ``` **See also:** - [sort()](#sort) - Sorts all elements without maintaining the key association ### splice() [](#splice) Removes a portion of the map and replace it with the given replacement, then return the updated map. ``` public function splice( int $offset, int $length = null, $replacement = [] ) : self ``` - @param **int** `$offset` Number of elements to start from - @param **int|null** `$length` Number of elements to remove, NULL for all - @param **mixed** `$replacement` List of elements to insert - @return **self<int|string,mixed>** New map The rules for offsets are: - If offset is non-negative, the sequence will start at that offset - If offset is negative, the sequence will start that far from the end Similar for the length: - If length is given and is positive, then the sequence will have up to that many elements in it - If the array is shorter than the length, then only the available array elements will be present - If length is given and is negative then the sequence will stop that many elements from the end - If it is omitted, then the sequence will have everything from offset up until the end Numerical array indexes are NOT preserved. **Examples:** ``` Map::from( ['a', 'b', 'c'] )->splice( 1 ); // ['b', 'c'] and map contains ['a'] Map::from( ['a', 'b', 'c'] )->splice( 1, 1, ['x', 'y'] ); // ['b'] and map contains ['a', 'x', 'y', 'c'] ``` ### strAfter() [](#strafter) Returns the strings after the passed value. ``` public function strAfter( string $value, bool $case = false, string $encoding = 'UTF-8' ) : self ``` - @param **string** `$value` Character or string to search for - @param **bool** `$case` TRUE if search should be case insensitive, FALSE if case-sensitive - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **self<int|string,mixed>** New map All scalar values (bool, int, float, string) will be converted to strings. Non-scalar values as well as empty strings will be skipped and are not part of the result. **Examples:** ``` Map::from( ['äöüß'] )->strAfter( 'ö' ); // ['üß'] Map::from( ['abc'] )->strAfter( '' ); // ['abc'] Map::from( ['abc'] )->strAfter( 'b' ); // ['c'] Map::from( ['abc'] )->strAfter( 'c' ); // [''] Map::from( ['abc'] )->strAfter( 'x' ) // [] Map::from( [''] )->strAfter( '' ); // [] Map::from( [1, 1.0, true, ['x'], new \stdClass] )->strAfter( '' ); // ['1', '1', '1'] Map::from( [0, 0.0, false, []] )->strAfter( '' ); // ['0', '0'] ``` **See also:** - [strBefore()](#strbefore) - Returns the strings before the passed value ### strBefore() [](#strbefore) Returns the strings before the passed value. ``` public function strBefore( string $value, bool $case = false, string $encoding = 'UTF-8' ) : self ``` - @param **string** `$value` Character or string to search for - @param **bool** `$case` TRUE if search should be case insensitive, FALSE if case-sensitive - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **self<int|string,mixed>** New map All scalar values (bool, int, float, string) will be converted to strings. Non-scalar values as well as empty strings will be skipped and are not part of the result. **Examples:** ``` Map::from( ['äöüß'] )->strBefore( 'ü' ); // ['äö'] Map::from( ['abc'] )->strBefore( '' ); // ['abc'] Map::from( ['abc'] )->strBefore( 'b' ); // ['a'] Map::from( ['abc'] )->strBefore( 'a' ); // [''] Map::from( ['abc'] )->strBefore( 'x' ) // [] Map::from( [''] )->strBefore( '' ); // [] Map::from( [1, 1.0, true, ['x'], new \stdClass] )->strBefore( '' ); // ['1', '1', '1'] Map::from( [0, 0.0, false, []] )->strBefore( '' ); // ['0', '0'] ``` **See also:** - [strAfter()](#strafter) - Returns the strings after the passed value ### strCompare() [](#strcompare) Compares the value against all map elements. ``` public function strCompare( string $value, bool $case = true ) : bool ``` - @param **string** `$value` Value to compare map elements to - @param **bool** `$case` TRUE if comparison is case sensitive, FALSE to ignore upper/lower case - @return **bool** TRUE If at least one element matches, FALSE if value is not in map All scalar values (bool, float, int and string) are casted to string values before comparing to the given value. Non-scalar values in the map are ignored. **Examples:** ``` Map::from( ['foo', 'bar'] )->strCompare( 'foo' ); // true Map::from( ['foo', 'bar'] )->strCompare( 'Foo', false ); // true (case insensitive) Map::from( [123, 12.3] )->strCompare( '12.3' ); // true Map::from( [false, true] )->strCompare( '1' ); // true Map::from( ['foo', 'bar'] )->strCompare( 'Foo' ); // false (case sensitive) Map::from( ['foo', 'bar'] )->strCompare( 'baz' ); // false Map::from( [new \stdClass(), 'bar'] )->strCompare( 'foo' ); // false ``` **See also:** - [contains()](#contains) - Tests if an item exists in the map - [in()](#in) - Tests if element is included - [includes()](#includes) - Tests if element is included ### strContains() [](#strcontains) Tests if at least one of the passed strings is part of at least one entry. ``` public function strContains( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if one of the entries contains one of the strings, FALSE if not **Examples:** ``` Map::from( ['abc'] )->strContains( '' ); // true Map::from( ['abc'] )->strContains( 'a' ); // true Map::from( ['abc'] )->strContains( 'bc' ); // true Map::from( [12345] )->strContains( '23' ); // true Map::from( [123.4] )->strContains( 23.4 ); // true Map::from( [12345] )->strContains( false ); // true ('12345' contains '') Map::from( [12345] )->strContains( true ); // true ('12345' contains '1') Map::from( [false] )->strContains( false ); // true ('' contains '') Map::from( [''] )->strContains( false ); // true ('' contains '') Map::from( ['abc'] )->strContains( ['b', 'd'] ); // true Map::from( ['abc'] )->strContains( 'c', 'ASCII' ); // true Map::from( ['abc'] )->strContains( 'd' ); // false Map::from( ['abc'] )->strContains( 'cb' ); // false Map::from( [23456] )->strContains( true ); // false ('23456' doesn't contain '1') Map::from( [false] )->strContains( 0 ); // false ('' doesn't contain '0') Map::from( ['abc'] )->strContains( ['d', 'e'] ); // false Map::from( ['abc'] )->strContains( 'cb', 'ASCII' ); // false ``` **See also:** - [strContainsAll()](#strcontainsall) - Tests if all of the entries contains one of the passed strings ### strContainsAll() [](#strcontainsall) Tests if all of the entries contains one of the passed strings. ``` public function strContainsAll( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if all of the entries contains at least one of the strings, FALSE if not **Examples:** ``` Map::from( ['abc', 'def'] )->strContainsAll( '' ); // true Map::from( ['abc', 'cba'] )->strContainsAll( 'a' ); // true Map::from( ['abc', 'bca'] )->strContainsAll( 'bc' ); // true Map::from( [12345, '230'] )->strContainsAll( '23' ); // true Map::from( [123.4, 23.42] )->strContainsAll( 23.4 ); // true Map::from( [12345, '234'] )->strContainsAll( [true, false] ); // true ('12345' contains '1' and '234' contains '') Map::from( ['', false] )->strContainsAll( false ); // true ('' contains '') Map::from( ['abc', 'def'] )->strContainsAll( ['b', 'd'] ); // true Map::from( ['abc', 'ecf'] )->strContainsAll( 'c', 'ASCII' ); // true Map::from( ['abc', 'def'] )->strContainsAll( 'd' ); // false Map::from( ['abc', 'cab'] )->strContainsAll( 'cb' ); // false Map::from( [23456, '123'] )->strContains( true ); // false ('23456' doesn't contain '1') Map::from( [false, '000'] )->strContains( 0 ); // false ('' doesn't contain '0') Map::from( ['abc', 'acf'] )->strContainsAll( ['d', 'e'] ); // false Map::from( ['abc', 'bca'] )->strContainsAll( 'cb', 'ASCII' ); // false ``` **See also:** - [strContains()](#strcontains) - Tests if at least one of the passed strings is part of at least one entry ### strEnds() [](#strends) Tests if at least one of the entries ends with one of the passed strings. ``` public function strEnds( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if one of the entries ends with the string, FALSE if not **Examples:** ``` Map::from( ['abc'] )->strEnds( '' ); // true Map::from( ['abc'] )->strEnds( 'c' ); // true Map::from( ['abc'] )->strEnds( 'bc' ); // true Map::from( ['abc'] )->strEnds( ['b', 'c'] ); // true Map::from( ['abc'] )->strEnds( 'c', 'ASCII' ); // true Map::from( ['abc'] )->strEnds( 'a' ); // false Map::from( ['abc'] )->strEnds( 'cb' ); // false Map::from( ['abc'] )->strEnds( ['d', 'b'] ); // false Map::from( ['abc'] )->strEnds( 'cb', 'ASCII' ); // false ``` **See also:** - [strEndsAll()](#strendsall) - Tests if all of the entries ends with at least one of the passed strings ### strEndsAll() [](#strendsall) Tests if all of the entries ends with at least one of the passed strings. ``` public function strEndsAll( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if all of the entries ends with at least one of the strings, FALSE if not **Examples:** ``` Map::from( ['abc', 'def'] )->strEndsAll( '' ); // true Map::from( ['abc', 'bac'] )->strEndsAll( 'c' ); // true Map::from( ['abc', 'cbc'] )->strEndsAll( 'bc' ); // true Map::from( ['abc', 'def'] )->strEndsAll( ['c', 'f'] ); // true Map::from( ['abc', 'efc'] )->strEndsAll( 'c', 'ASCII' ); // true Map::from( ['abc', 'fed'] )->strEndsAll( 'd' ); // false Map::from( ['abc', 'bca'] )->strEndsAll( 'ca' ); // false Map::from( ['abc', 'acf'] )->strEndsAll( ['a', 'c'] ); // false Map::from( ['abc', 'bca'] )->strEndsAll( 'ca', 'ASCII' ); // false ``` **See also:** - [strEnds()](#strends) - Tests if at least one of the entries ends with one of the passed strings ### string() [](#string) Returns an element by key and casts it to string if possible. ``` public function string( $key, $default = '' ) : string ``` - @param **int|string** `$key` Key or path to the requested item - @param **mixed** `$default` Default value if key isn't found (will be casted to string) - @return **string** Value from map or default value This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( ['a' => true] )->string( 'a' ); // '1' Map::from( ['a' => 1] )->string( 'a' ); // '1' Map::from( ['a' => 1.1] )->string( 'a' ); // '1.1' Map::from( ['a' => 'abc'] )->string( 'a' ); // 'abc' Map::from( ['a' => ['b' => ['c' => 'yes']]] )->string( 'a/b/c' ); // 'yes' Map::from( [] )->string( 'c', function() { return 'no'; } ); // 'no' Map::from( [] )->string( 'b' ); // '' Map::from( ['b' => ''] )->string( 'b' ); // '' Map::from( ['b' => null] )->string( 'b' ); // '' Map::from( ['b' => [true]] )->string( 'b' ); // '' Map::from( ['b' => '#resource'] )->string( 'b' ); // '' (resources are not scalar) Map::from( ['b' => new \stdClass] )->string( 'b' ); // '' (objects are not scalar) Map::from( [] )->string( 'c', new \Exception( 'error' ) ); // throws exception ``` **See also:** - [bool()](#bool) - Returns an element by key and casts it to boolean if possible - [cast()](#cast) - Casts all entries to the passed type - [get()](#get) - Returns an element from the map by key - [float()](#float) - Returns an element by key and casts it to float if possible - [int()](#int) - Returns an element by key and casts it to integer if possible ### strLower() [](#strlower) Converts all alphabetic characters in strings to lower case. ``` public function strLower( string $encoding = 'UTF-8' ) : self ``` - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['My String'] )->strLower(); // ["my string"] Map::from( ['Τάχιστη'] )->strLower(); // ["τάχιστη"] Map::from( ['Äpfel', 'Birnen'] )->strLower( 'ISO-8859-1' ); // ["äpfel", "birnen"] ``` **See also:** - [strUpper()](#strupper) - Converts all alphabetic characters in strings to upper case ### strReplace() [](#strreplace) Replaces all occurrences of the search string with the replacement string. ``` public function strReplace( $search, $replace, bool $case = false ) : self ``` - @param **array|string** `$search` String or list of strings to search for - @param **array|string** `$replace` String or list of strings of replacement strings - @param **bool** `$case` TRUE if replacements should be case insensitive, FALSE if case-sensitive - @return **self<int|string,mixed>** Updated map for fluid interface If you use an array of strings for search or search/replacement, the order of the strings matters! Each search string found is replaced by the corresponding replacement string at the same position. In case of array parameters and if the number of replacement strings is less than the number of search strings, the search strings with no corresponding replacement string are replaced with empty strings. Replacement strings with no corresponding search string are ignored. An array parameter for the replacements is only allowed if the search parameter is an array of strings too! Because the method replaces from left to right, it might replace a previously inserted value when doing multiple replacements. Entries which are non-string values are left untouched. **Examples:** ``` Map::from( ['google.com', 'aimeos.com'] )->strReplace( '.com', '.de' ); // ['google.de', 'aimeos.de'] Map::from( ['google.com', 'aimeos.org'] )->strReplace( ['.com', '.org'], '.de' ); // ['google.de', 'aimeos.de'] Map::from( ['google.com', 'aimeos.org'] )->strReplace( ['.com', '.org'], ['.de'] ); // ['google.de', 'aimeos'] Map::from( ['google.com', 'aimeos.org'] )->strReplace( ['.com', '.org'], ['.fr', '.de'] ); // ['google.fr', 'aimeos.de'] Map::from( ['google.com', 'aimeos.com'] )->strReplace( ['.com', '.co'], ['.co', '.de', '.fr'] ); // ['google.de', 'aimeos.de'] Map::from( ['google.com', 'aimeos.com', 123] )->strReplace( '.com', '.de' ); // ['google.de', 'aimeos.de', 123] Map::from( ['GOOGLE.COM', 'AIMEOS.COM'] )->strReplace( '.com', '.de', true ); // ['GOOGLE.de', 'AIMEOS.de'] ``` ### strStarts() [](#strstarts) Tests if at least one of the entries starts with at least one of the passed strings. ``` public function strStarts( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if one of the entries starts with one of the strings, FALSE if not **Examples:** ``` Map::from( ['abc'] )->strStarts( '' ); // true Map::from( ['abc'] )->strStarts( 'a' ); // true Map::from( ['abc'] )->strStarts( 'ab' ); // true Map::from( ['abc'] )->strStarts( ['a', 'b'] ); // true Map::from( ['abc'] )->strStarts( 'ab', 'ASCII' ); // true Map::from( ['abc'] )->strStarts( 'b' ); // false Map::from( ['abc'] )->strStarts( 'bc' ); // false Map::from( ['abc'] )->strStarts( ['b', 'c'] ); // false Map::from( ['abc'] )->strStarts( 'bc', 'ASCII' ); // false ``` **See also:** - [strStartsAll()](#strstartsall) - Tests if all of the entries starts with one of the passed strings ### strStartsAll() [](#strstartsall) Tests if all of the entries starts with one of the passed strings. ``` public function strStartsAll( $value, string $encoding = 'UTF-8' ) : bool ``` - @param **array|string** `$value` The string or list of strings to search for in each entry - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **bool** TRUE if one of the entries starts with one of the strings, FALSE if not **Examples:** ``` Map::from( ['abc', 'def'] )->strStartsAll( '' ); // true Map::from( ['abc', 'acb'] )->strStartsAll( 'a' ); // true Map::from( ['abc', 'aba'] )->strStartsAll( 'ab' ); // true Map::from( ['abc', 'def'] )->strStartsAll( ['a', 'd'] ); // true Map::from( ['abc', 'acf'] )->strStartsAll( 'a', 'ASCII' ); // true Map::from( ['abc', 'def'] )->strStartsAll( 'd' ); // false Map::from( ['abc', 'bca'] )->strStartsAll( 'ab' ); // false Map::from( ['abc', 'bac'] )->strStartsAll( ['a', 'c'] ); // false Map::from( ['abc', 'cab'] )->strStartsAll( 'ab', 'ASCII' ); // false ``` **See also:** - [strStarts()](#strstarts) - Tests if at least one of the entries starts with at least one of the passed strings ### strUpper() [](#strupper) Converts all alphabetic characters in strings to upper case. ``` public function strUpper( string $encoding = 'UTF-8' ) :self ``` - @param **string** `$encoding` Character encoding of the strings, e.g. "UTF-8" (default), "ASCII", "ISO-8859-1", etc. - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( ['My String'] )->strUpper(); // ["MY STRING"] Map::from( ['τάχιστη'] )->strUpper(); // ["ΤΆΧΙΣΤΗ"] Map::from( ['äpfel', 'birnen'] )->strUpper( 'ISO-8859-1' ); // ["ÄPFEL", "BIRNEN"] ``` **See also:** - [strLower()](#strlower) - Converts all alphabetic characters in strings to lower case ### suffix [](#suffix) Adds a suffix at the end of each map entry. ``` public function suffix( $suffix, int $depth = null ) : self ``` - @param **\\Closure|string** `$suffix` Function with map as parameter which returns arbitrary result - @param **int|null** `$depth` Maximum depth to dive into multi-dimensional arrays starting from "1" - @return **self<int|string,mixed>** Updated map for fluid interface By defaul, nested arrays are walked recusively so all entries at all levels are suffixed. The keys are preserved using this method. **Examples:** ``` Map::from( ['a', 'b'] )->suffix( '-1' ); // ['a-1', 'b-1'] Map::from( ['a', ['b']] )->suffix( '-1' ); // ['a-1', ['b-1']] Map::from( ['a', ['b']] )->suffix( '-1', 1 ); // ['a-1', ['b']] Map::from( ['a', 'b'] )->suffix( function( $item, $key ) { return '-' . ( ord( $item ) + ord( $key ) ); } ); // ['a-145', 'b-147'] ``` **See also:** - [prefix()](#prefix) - Adds a prefix in front of each map entry ### sum() [](#sum) Returns the sum of all integer and float values in the map. ``` public function sum( $col = null ) : float ``` - @param **Closure|string|null** `$col` Closure, key in the nested array or object to sum up - @return **float** Sum of all elements or 0 if there are no elements in the map Non-numeric values will be removed before calculation. This does also work to map values from multi-dimensional arrays by passing the keys of the arrays separated by the delimiter ("/" by default), e.g. `key1/key2/key3`to get `val` from `['key1' => ['key2' => ['key3' => 'val']]]`. The same applies to public properties of objects or objects implementing `__isset()` and `__get()` methods. **Examples:** ``` Map::from( [1, 3, 5] )->sum(); // 9 Map::from( [1, 'sum', 5] )->sum(); // 6 Map::from( [['p' => 30], ['p' => 50], ['p' => 10]] )->sum( 'p' ); // 90 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->sum( 'i/p' ); // 80 Map::from( [['i' => ['p' => 30]], ['i' => ['p' => 50]]] )->sum( fn( $val, $key ) => $val['i']['p'] ?? null ) // 80 Map::from( [30, 50, 10] )->sum( fn( $val, $key ) => $val < 50 ); // 40 ``` **See also:** - [avg()](#avg) - Returns the average of all integer and float values in the map - [count()](#count) - Returns the total number of elements - [max()](#max) - Returns the maximum value of all elements - [min()](#min) - Returns the minium value of all elements - [percentage()](#percentage) - Returns the percentage of all elements passing the test ### take() [](#take) Returns a new map with the given number of items. ``` public function take( int $size, $offset = 0 ) : self ``` - @param **int** `$size` Number of items to return - @param **\\Closure|int** `$offset` Number of items to skip or function($item, $key) returning true for skipped items - @return **self<int|string,mixed>** New map The keys of the items returned in the new map are the same as in the original one. **Examples:** ``` Map::from( [1, 2, 3, 4] )->take( 2 ); // [0 => 1, 1 => 2] Map::from( [1, 2, 3, 4] )->take( 2, 1 ); // [1 => 2, 2 => 3] Map::from( [1, 2, 3, 4] )->take( 2, -2 ); // [2 => 3, 3 => 4] Map::from( [1, 2, 3, 4] )->take( 2, function( $item, $key ) { return $item < 2; } ); // [1 => 2, 2 => 3] ``` **See also:** - [slice()](#slice) - Returns a map with the slice from the original map. ### tap() [](#tap) Passes a clone of the map to the given callback. ``` public function tap( callable $callback ) : self ``` - @param **callable** `$callback` Function receiving ($map) parameter - @return **self<int|string,mixed>** Same map for fluid interface Use it to "tap" into a chain of methods to check the state between two method calls. The original map is not altered by anything done in the callback. **Examples:** ``` Map::from( [3, 2, 1] )->rsort()->tap( function( $map ) { print_r( $map->remove( 0 )->toArray() ); } )->first(); // 1 ``` It will sort the list in reverse order(`[1, 2, 3]`), then prints the items (`[2, 3]`) without the first one in the function passed to `tap()` and returns the first item ("1") at the end. ### times() [](#times) Creates a new map by invoking the closure the given number of times. ``` public static function times( int $num, \Closure $callback ) : self ``` - @param **int** `$num` Number of times the function is called - @param **\\Closure** `$callback` Function with (value, key) parameters and returns new value - @return **self<int|string,mixed>** New map with the generated elements This method creates a lazy Map and the entries are generated after calling another method that operates on the Map contents. Thus, the passed callback is not called immediately! **Examples:** ``` Map::times( 3, function( $num ) { return $num * 10; } ); // [0 => 0, 1 => 10, 2 => 20] Map::times( 3, function( $num, &$key ) { $key = $num * 2; return $num * 5; } ); // [0 => 0, 2 => 5, 4 => 10] Map::times( 2, function( $num ) { return new \stdClass(); } ); // [0 => new \stdClass(), 1 => new \stdClass()] ``` ### to() [](#to) Returns the elements as a plain array. ``` public function to() : array ``` - @return **array** Plain array **Examples:** ``` Map::from( ['a'] )->to(); // ['a'] ``` This is the preferred method for retrieving the plain array of the Map object. **See also:** - [all()](#all) - Returns the elements as a plain array - [toArray()](#toarray) - Returns the elements as a plain array ### toArray() [](#toarray) Returns the elements as a plain array. ``` public function toArray() : array ``` - @return **array** Plain array **Examples:** ``` Map::from( ['a'] )->toArray(); // ['a'] ``` **See also:** - [all()](#all) - Returns the elements as a plain array - [to()](#to) - Returns the elements as a plain array ### toJson() [](#tojson) Returns the elements encoded as JSON string. ``` public function toJson( int $options = 0 ) : ?string ``` - @param **int** `$options` Combination of JSON\_\* constants - @return **string|null** Array encoded as JSON string or NULL on failure There are several options available to modify the JSON string which are described in the [PHP json\_encode() manual](https://www.php.net/manual/en/function.json-encode.php). The parameter can be a single JSON\_\* constant or a bitmask of several constants combine by bitwise OR (|), e.g.: ``` JSON_FORCE_OBJECT|JSON_HEX_QUOT ``` **Examples:** ``` Map::from( ['a', 'b'] )->toJson(); // '["a","b"]' Map::from( ['a' => 'b'] )->toJson(); // '{"a":"b"}' Map::from( ['a', 'b'] )->toJson( JSON_FORCE_OBJECT ); // '{"0":"a", "1":"b"}' ``` ### toReversed() [](#toreversed) Reverses the element order in a copy of the map (alias). ``` public function toReversed() : self ``` - @return **self<int|string,mixed>** New map with a reversed copy of the elements This method is an alias for [reversed()](#reversed). For performance reasons, reversed() should be preferred because it uses one method call less than toReversed(). **See also:** - [reversed()](#reversed) - Underlying method with same parameters and return value but better performance ### toSorted() [](#tosorted) Sorts the elements in a copy of the map using new keys (alias). ``` public function toSorted( int $options = SORT_REGULAR ) : self ``` - @param **int** `$options` Sort options for PHP `sort()` - @return **self<int|string,mixed>** New map with a sorted copy of the elements This method is an alias for [sorted()](#sorted). For performance reasons, sorted() should be preferred because it uses one method call less than toSorted(). A new map is created by calling this method. **See also:** - [sorted()](#sorted) - Underlying method with same parameters and return value but better performance ### toUrl() [](#tourl) Creates a HTTP query string from the map elements. ``` public function toUrl() : string ``` - @return **string** Parameter string for GET requests **Examples:** ``` Map::from( ['a' => 1, 'b' => 2] )->toUrl(); // a=1&b=2 Map::from( ['a' => ['b' => 'abc', 'c' => 'def'], 'd' => 123] )->toUrl(); // a%5Bb%5D=abc&a%5Bc%5D=def&d=123 ``` ### transform() [](#transform) Creates new key/value pairs using the passed function and returns a new map for the result. ``` public function transform( \Closure $callback ) : self ``` - @param **\\Closure** `$callback` Function with (value, key) parameters and returns an array of new key/value pair(s) - @return **self<int|string,mixed>** New map with the new key/value pairs If a key is returned twice, the last value will overwrite previous values. **Examples:** ``` Map::from( ['a' => 2, 'b' => 4] )->transform( function( $value, $key ) { return [$key . '-2' => $value * 2]; } ); // ['a-2' => 4, 'b-2' => 8] Map::from( ['a' => 2, 'b' => 4] )->transform( function( $value, $key ) { return [$key => $value * 2, $key . $key => $value * 4]; } ); // ['a' => 4, 'aa' => 8, 'b' => 8, 'bb' => 16] Map::from( ['a' => 2, 'b' => 4] )->transform( function( $value, $key ) { return $key < 'b' ? [$key => $value * 2] : null; } ); // ['a' => 4] Map::from( ['la' => 2, 'le' => 4, 'li' => 6] )->transform( function( $value, $key ) { return [$key[0] => $value * 2]; } ); // ['l' => 12] ``` **See also:** - [map()](#map) - Maps new values to the existing keys using the passed function and returns a new map for the result - [rekey()](#rekey) - Changes the keys according to the passed function ### transpose() [](#transpose) Exchanges rows and columns for a two dimensional map. ``` public function transpose() : self ``` - @return **self<int|string,mixed>** New map **Examples:** ``` Map::from( [ ['name' => 'A', 2020 => 200, 2021 => 100, 2022 => 50], ['name' => 'B', 2020 => 300, 2021 => 200, 2022 => 100], ['name' => 'C', 2020 => 400, 2021 => 300, 2022 => 200], ] )->transpose(); /* [ 'name' => ['A', 'B', 'C'], 2020 => [200, 300, 400], 2021 => [100, 200, 300], 2022 => [50, 100, 200] ] */ Map::from( [ ['name' => 'A', 2020 => 200, 2021 => 100, 2022 => 50], ['name' => 'B', 2020 => 300, 2021 => 200], ['name' => 'C', 2020 => 400] ] ); /* [ 'name' => ['A', 'B', 'C'], 2020 => [200, 300, 400], 2021 => [100, 200], 2022 => [50] ] */ ``` ### traverse() [](#traverse) Traverses trees of nested items passing each item to the callback. ``` public function traverse( \Closure $callback = null, string $nestKey = 'children' ) : self ``` - @param **\\Closure|null** `$callback` Callback with (entry, key, level, $parent) arguments, returns the entry added to result - @param **string** `$nestKey` Key to the children of each item - @return **self<int|string,mixed>** New map with all items as flat list This does work for nested arrays and objects with public properties or objects implementing `__isset()` and `__get()` methods. To build trees of nested items, use the [tree()](#tree) method. **Examples:** ``` Map::from( [[ 'id' => 1, 'pid' => null, 'name' => 'n1', 'children' => [ ['id' => 2, 'pid' => 1, 'name' => 'n2', 'children' => []], ['id' => 3, 'pid' => 1, 'name' => 'n3', 'children' => []] ] ]] )->traverse(); /* [ ['id' => 1, 'pid' => null, 'name' => 'n1', 'children' => [...]], ['id' => 2, 'pid' => 1, 'name' => 'n2', 'children' => []], ['id' => 3, 'pid' => 1, 'name' => 'n3', 'children' => []], ] */ Map::from( [[ 'id' => 1, 'pid' => null, 'name' => 'n1', 'children' => [ ['id' => 2, 'pid' => 1, 'name' => 'n2', 'children' => []], ['id' => 3, 'pid' => 1, 'name' => 'n3', 'children' => []] ] ]] )->traverse( function( $entry, $key, $level ) { return str_repeat( '-', $level ) . '- ' . $entry['name']; } ); // ['- n1', '-- n2', '-- n3'] Map::from( [[ 'id' => 1, 'pid' => null, 'name' => 'n1', 'children' => [ ['id' => 2, 'pid' => 1, 'name' => 'n2', 'children' => []], ['id' => 3, 'pid' => 1, 'name' => 'n3', 'children' => []] ] ]] )->traverse( function( &$entry, $key, $level, $parent ) { $entry['path'] = isset( $parent['path'] ) ? $parent['path'] . '/' . $entry['name'] : $entry['name']; return $entry; } ); /* [ ['id' => 1, 'pid' => null, 'name' => 'n1', 'children' => [...], 'path' => 'n1'], ['id' => 2, 'pid' => 1, 'name' => 'n2', 'children' => [], 'path' => 'n1/n2'], ['id' => 3, 'pid' => 1, 'name' => 'n3', 'children' => [], 'path' => 'n1/n3'], ] */ Map::from( [[ 'id' => 1, 'pid' => null, 'name' => 'n1', 'nodes' => [ ['id' => 2, 'pid' => 1, 'name' => 'n2', 'nodes' => []] ] ]] )->traverse( null, 'nodes' ); /* [ ['id' => 1, 'pid' => null, 'name' => 'n1', 'nodes' => [...]], ['id' => 2, 'pid' => 1, 'name' => 'n2', 'nodes' => []], ] */ ``` **See also:** - [tree()](#tree) - Creates a tree structure from the list items ### tree() [](#tree) Creates a tree structure from the list items. ``` public function tree( string $idKey, string $parentKey, string $nestKey = 'children' ) : self ``` - @param **string** `$idKey` Name of the key with the unique ID of the node - @param **string** `$parentKey` Name of the key with the ID of the parent node - @param **string** `$nestKey` Name of the key with will contain the children of the node - @return **self<int|string,mixed>** New map with one or more root tree nodes Use this method to rebuild trees e.g. from database records. To traverse trees, use the [traverse()](#traverse) method. **Examples:** ``` Map::from( [ ['id' => 1, 'pid' => null, 'lvl' => 0, 'name' => 'n1'], ['id' => 2, 'pid' => 1, 'lvl' => 1, 'name' => 'n2'], ['id' => 3, 'pid' => 2, 'lvl' => 2, 'name' => 'n3'], ['id' => 4, 'pid' => 1, 'lvl' => 1, 'name' => 'n4'], ['id' => 5, 'pid' => 3, 'lvl' => 2, 'name' => 'n5'], ['id' => 6, 'pid' => 1, 'lvl' => 1, 'name' => 'n6'], ] )->tree( 'id', 'pid' ); /* [1 => [ 'id' => 1, 'pid' => null, 'lvl' => 0, 'name' => 'n1', 'children' => [ 2 => ['id' => 2, 'pid' => 1, 'lvl' => 1, 'name' => 'n2', 'children' => [ 3 => ['id' => 3, 'pid' => 2, 'lvl' => 2, 'name' => 'n3', 'children' => []] ]], 4 => ['id' => 4, 'pid' => 1, 'lvl' => 1, 'name' => 'n4', 'children' => [ 5 => ['id' => 5, 'pid' => 3, 'lvl' => 2, 'name' => 'n5', 'children' => []] ]], 6 => ['id' => 6, 'pid' => 1, 'lvl' => 1, 'name' => 'n6', 'children' => []] ] ]] */ ``` To build the tree correctly, the items must be in order or at least the nodes of the lower levels must come first. For a tree like this: ``` n1 |- n2 | |- n3 |- n4 | |- n5 |- n6 ``` Accepted item order: - in order: n1, n2, n3, n4, n5, n6 - lower levels first: n1, n2, n4, n6, n3, n5 If your items are unordered, apply [usort()](#usort) first to the map entries, e.g. ``` Map::from( [['id' => 3, 'lvl' => 2], ...] )->usort( function( $item1, $item2 ) { return $item1['lvl'] $item2['lvl']; } ); ``` **See also:** - [traverse()](#traverse) - Traverses trees of nested items passing each item to the callback ### trim() [](#trim) Removes the passed characters from the left/right of all strings. ``` public function trim( string $chars = " \n\r\t\v\x00" ) : self ``` - @param **string** `$chars` List of characters to trim - @return **self<int|string,mixed>** Updated map for fluid interface **Examples:** ``` Map::from( [" abc\n", "\tcde\r\n"] )->trim(); // ["abc", "cde"] Map::from( ["a b c", "cbax"] )->trim( 'abc' ); // [" b ", "x"] ``` **See also:** - [ltrim()](#ltrim) - Removes the passed characters from the left of all strings - [rtrim()](#rtrim) - Removes the passed characters from the right of all strings ### uasort() [](#uasort) Sorts all elements using a callback and maintains the key association. ``` public function uasort( callable $callback ) : self ``` - @param **callable** `$callback` Function with (itemA, itemB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** Updated map for fluid interface The given callback will be used to compare the values. The callback must accept two parameters (item A and B) and must return -1 if item A is smaller than item B, 0 if both are equal and 1 if item A is greater than item B. Both, a method name and an anonymous function can be passed. The keys are preserved using this method and no new map is created. **Examples:** ``` Map::from( ['a' => 'B', 'b' => 'a'] )->uasort( 'strcasecmp' ); // ['b' => 'a', 'a' => 'B'] Map::from( ['a' => 'B', 'b' => 'a'] )->uasort( function( $itemA, $itemB ) { return strtolower( $itemA ) strtolower( $itemB ); } ); // ['b' => 'a', 'a' => 'B'] ``` **See also:** - [uasorted()](#uasorted) - Sorts a copy of all elements using a callback and maintains the key association ### uasorted() [](#uasorted) Sorts a copy of all elements using a callback and maintains the key association. ``` public function uasorted( callable $callback ) : self ``` - @param **callable** `$callback` Function with (itemA, itemB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** Updated map for fluid interface The given callback will be used to compare the values. The callback must accept two parameters (item A and B) and must return -1 if item A is smaller than item B, 0 if both are equal and 1 if item A is greater than item B. Both, a method name and an anonymous function can be passed. The keys are preserved using this method and a new map is created. **Examples:** ``` Map::from( ['a' => 'B', 'b' => 'a'] )->uasorted( 'strcasecmp' ); // ['b' => 'a', 'a' => 'B'] Map::from( ['a' => 'B', 'b' => 'a'] )->uasorted( function( $itemA, $itemB ) { return strtolower( $itemA ) strtolower( $itemB ); } ); // ['b' => 'a', 'a' => 'B'] ``` **See also:** - [uasort()](#uasort) - Sorts all elements using a callback and maintains the key association ### uksort() [](#uksort) Sorts the map elements by their keys using a callback. ``` public function uksort( callable $callback ) : self ``` - @param **callable** `$callback` Function with (keyA, keyB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map The given callback will be used to compare the keys. The callback must accept two parameters (key A and B) and must return -1 if key A is smaller than key B, 0 if both are equal and 1 if key A is greater than key B. Both, a method name and an anonymous function can be passed. The keys are preserved using this method and no new map is created. **Examples:** ``` Map::from( ['B' => 'a', 'a' => 'b'] )->uksort( 'strcasecmp' ); // ['a' => 'b', 'B' => 'a'] Map::from( ['B' => 'a', 'a' => 'b'] )->uksort( function( $keyA, $keyB ) { return strtolower( $keyA ) strtolower( $keyB ); } ); // ['a' => 'b', 'B' => 'a'] ``` **See also:** - [uksorted()](#uksorted) - Sorts a copy of the map elements by their keys using a callback ### uksorted() [](#uksorted) Sorts a copy of the map elements by their keys using a callback. ``` public function uksorted( callable $callback ) : self ``` - @param **callable** `$callback` Function with (keyA, keyB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** Updated map for fluid interface The given callback will be used to compare the keys. The callback must accept two parameters (key A and B) and must return -1 if key A is smaller than key B, 0 if both are equal and 1 if key A is greater than key B. Both, a method name and an anonymous function can be passed. The keys are preserved using this method and a new map is created. **Examples:** ``` Map::from( ['B' => 'a', 'a' => 'b'] )->uksorted( 'strcasecmp' ); // ['a' => 'b', 'B' => 'a'] Map::from( ['B' => 'a', 'a' => 'b'] )->uksorted( function( $keyA, $keyB ) { return strtolower( $keyA ) strtolower( $keyB ); } ); // ['a' => 'b', 'B' => 'a'] ``` **See also:** - [uksort()](#uksort) - Sorts the map elements by their keys using a callback ### unflatten() [](#unflatten) Unflattens the key path/value pairs into a multi-dimensional array. ``` public function unflatten() : self ``` This is the inverse method for [flatten()](#flatten). - @return **self<string,mixed>** New map with multi-dimensional arrays **Examples:** ``` Map::from( ['a/b/c' => 1, 'a/b/d' => 2, 'b/e' => 3] )->unflatten(); // ['a' => ['b' => ['c' => 1, 'd' => 2]], 'b' => ['e' => 3]] Map::from( ['a.b.c' => 1, 'a.b.d' => 2, 'b.e' => 3] )->sep( '.' )->unflatten(); // ['a' => ['b' => ['c' => 1, 'd' => 2]], 'b' => ['e' => 3]] ``` **See also:** - [collapse()](#collapse) - Collapses all sub-array elements recursively to a new map - [flat()](#flat) - Flattens multi-dimensional elements without overwriting elements - [flatten()](#flatten) - Creates a new map with keys joined recursively ### union() [](#union) Builds a union of the elements and the given elements without returning a new map. Existing keys in the map will not be overwritten ``` public function union( iterable $elements ) : self ``` - @param **iterable<int|string,mixed>** `$elements` List of elements - @return **self<int|string,mixed>** Updated map for fluid interface If list entries should be overwritten, use [merge()](#merge) instead. The keys are preserved using this method and no new map is created. **Examples:** ``` Map::from( [0 => 'a', 1 => 'b'] )->union( [0 => 'c'] ); // [0 => 'a', 1 => 'b'] because the key 0 isn't overwritten Map::from( ['a' => 1, 'b' => 2] )->union( ['c' => 1] ); // ['a' => 1, 'b' => 2, 'c' => 1] ``` **See also:** - [concat()](#combine) - Adds all elements with new keys - [merge()](#merge) - Merges the map with the given elements without returning a new map ### unique() [](#unique) Returns only unique elements from the map in a new map. ``` public function unique( $col = null ) : self ``` - @param **\\Closure|string|null** `$col` Key, path of the nested array or anonymous function with ($item, $key) parameters returning the value for comparison - @return **self<int|string,mixed>** New map Two elements are considered equal if comparing their string representions returns TRUE: ``` (string) $elem1 === (string) $elem2 ``` The keys of the elements are preserved in the new map. **Examples:** ``` Map::from( [0 => 'a', 1 => 'b', 2 => 'b', 3 => 'c'] )->unique(); // [0 => 'a', 1 => 'b', 3 => 'c'] Map::from( [['p' => '1'], ['p' => 1], ['p' => 2]] )->unique( 'p' ); // [0 => ['p' => '1'], 2 => ['p' => 2]] Map::from( [['i' => ['p' => '1']], ['i' => ['p' => 1]]] )->unique( 'i/p' ); // [0 => ['i' => ['p' => '1']]] Map::from( [['i' => ['p' => '1']], ['i' => ['p' => 1]]] )->unique( fn( $item, $key ) => $item['i']['p'] ); // [0 => ['i' => ['p' => '1']]] ``` **See also:** - [duplicates()](#duplicates) - Returns the duplicate values from the map ### unshift() [](#unshift) Pushes an element onto the beginning of the map without returning a new map. ``` public function unshift( $value, $key = null ) : self ``` - @param **mixed** `$value` Item to add at the beginning - @param **int|string|null** `$key` Key for the item or NULL to reindex all numerical keys - @return **self<int|string,mixed>** Updated map for fluid interface The keys of the elements are only preserved in the new map if no key is passed. **Examples:** ``` Map::from( ['a', 'b'] )->unshift( 'd' ); // ['d', 'a', 'b'] Map::from( ['a', 'b'] )->unshift( 'd', 'first' ); // ['first' => 'd', 0 => 'a', 1 => 'b'] ``` **Performance note:** The bigger the list, the higher the performance impact because `unshift()`needs to create a new list and copies all existing elements to the new array. Usually, it's better to [push()](#push) new entries at the end and [reverse()](#reverse) the list afterwards: ``` $map->push( 'a' )->push( 'b' )->reverse(); ``` instead of ``` $map->unshift( 'a' )->unshift( 'b' ); ``` **See also:** - [shift()](#shift) - Returns and removes the first element from the map ### usort() [](#usort) Sorts all elements using a callback without maintaining the key association. ``` public function usort( callable $callback ) : self ``` - @param **callable** `$callback` Function with (itemA, itemB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** Updated map for fluid interface The given callback will be used to compare the values. The callback must accept two parameters (item A and B) and must return -1 if item A is smaller than item B, 0 if both are equal and 1 if item A is greater than item B. Both, a method name and an anonymous function can be passed. The keys are NOT preserved and elements get a new index. No new map is created. **Examples:** ``` Map::from( ['a' => 'B', 'b' => 'a'] )->usort( 'strcasecmp' ); // [0 => 'a', 1 => 'B'] Map::from( ['a' => 'B', 'b' => 'a'] )->usort( function( $itemA, $itemB ) { return strtolower( $itemA ) strtolower( $itemB ); } ); // [0 => 'a', 1 => 'B'] ``` **See also:** - [usorted()](#usorted) - Sorts a copy of all elements using a callback without maintaining the key association ### usorted() [](#usorted) Sorts a copy of all elements using a callback without maintaining the key association. ``` public function usorted( callable $callback ) : self ``` - @param **callable** `$callback` Function with (itemA, itemB) parameters and returns -1 (<), 0 (=) and 1 (>) - @return **self<int|string,mixed>** New map The given callback will be used to compare the values. The callback must accept two parameters (item A and B) and must return -1 if item A is smaller than item B, 0 if both are equal and 1 if item A is greater than item B. Both, a method name and an anonymous function can be passed. The keys are NOT preserved and elements get a new index and a new map is created. **Examples:** ``` Map::from( ['a' => 'B', 'b' => 'a'] )->usorted( 'strcasecmp' ); // [0 => 'a', 1 => 'B'] Map::from( ['a' => 'B', 'b' => 'a'] )->usorted( function( $itemA, $itemB ) { return strtolower( $itemA ) strtolower( $itemB ); } ); // [0 => 'a', 1 => 'B'] ``` **See also:** - [usort()](#usort) - Sorts all elements using a callback without maintaining the key association ### values() [](#values) Resets the keys and return the values in a new map. ``` public function values() : self ``` - @return **self<int|string,mixed>** New map of the values **Examples:** ``` Map::from( ['x' => 'b', 2 => 'a', 'c'] )->values(); // [0 => 'b', 1 => 'a', 2 => 'c'] ``` ### walk() [](#walk) Applies the given callback to all elements. ``` public function walk( callable $callback, $data = null, bool $recursive = true ) : self ``` - @param **callable** `$callback` Function with (item, key, data) parameters - @param **mixed** `$data` Arbitrary data that will be passed to the callback as third parameter - @param **bool** `$recursive` TRUE to traverse sub-arrays recursively (default), FALSE to iterate Map elements only - @return **self<int|string,mixed>** Updated map for fluid interface To change the values of the Map, specify the value parameter as reference (`&$value`). You can only change the values but not the keys nor the array structure. By default, Map elements which are arrays will be traversed recursively. To iterate over the Map elements only, pass FALSE as third parameter. **Examples:** ``` Map::from( ['a', 'B', ['c', 'd'], 'e'] )->walk( function( &$value ) { $value = strtoupper( $value ); } ); // ['A', 'B', ['C', 'D'], 'E'] Map::from( [66 => 'B', 97 => 'a'] )->walk( function( $value, $key ) { echo 'ASCII ' . $key . ' is ' . $value . "\n"; } ); /* ASCII 66 is B ASCII 97 is a */ Map::from( [1, 2, 3] )->walk( function( &$value, $key, $data ) { $value = $data[$value] ?? $value; }, [1 => 'one', 2 => 'two'] ); // ['one', 'two', 3] ``` ### where() [](#where) Filters the list of elements by a given condition. ``` public function where( string $key, string $op, $value ) : self ``` - @param **string** `$key` Key or path of the value of the array or object used for comparison - @param **string** `$op` Operator used for comparison - @param **mixed** `$value` Value used for comparison - @return **self<int|string,mixed>** New map for fluid interface Available operators are: - '==' : Equal - '===' : Equal and same type - '!=' : Not equal - '!==' : Not equal and same type - '<=' : Smaller than an equal - '>=' : Greater than an equal - '<' : Smaller - '>' : Greater - 'in' : Array of value which are in the list of values - '-' : Values between array of start and end value, e.g. \[10, 100\] (inclusive) The keys of the original map are preserved in the returned map. **Examples:** ``` Map::from( [ ['id' => 1, 'type' => 'name'], ['id' => 2, 'type' => 'short'], ] )->where( 'type', '==', 'name' ); /* [ ['id' => 1, 'type' => 'name'] ] */ Map::from( [ ['id' => 3, 'price' => 10], ['id' => 4, 'price' => 50], ] )->where( 'price', '>', 20 ); /* [ ['id' => 4, 'price' => 50] ] */ Map::from( [ ['id' => 3, 'price' => 10], ['id' => 4, 'price' => 50], ] )->where( 'price', 'in', [10, 25] ); /* [ ['id' => 3, 'price' => 10] ] */ Map::from( [ ['id' => 3, 'price' => 10], ['id' => 4, 'price' => 50], ] )->where( 'price', '-', [10, 100] ); /* [ ['id' => 3, 'price' => 10], ['id' => 4, 'price' => 50] ] */ Map::from( [ ['item' => ['id' => 3, 'price' => 10]], ['item' => ['id' => 4, 'price' => 50]], ] )->where( 'item/price', '>', 30 ); /* [ ['id' => 4, 'price' => 50] ] */ ``` **See also:** - [filter()](#filter) - Runs a filter over each element of the map and returns a new map - [grep()](#grep) - Applies a regular expression to all elements ### with() [](#with) Returns a copy of the map with the element at the given index replaced with the given value. ``` public function with( $key, $value ) : self ``` - @param **int|string** `$key` Array key to set or replace - @param **mixed** `$value` New value for the given key - @return **self<int|string,mixed>** New map of the values The original map stays untouched! This method is a shortcut for calling the [copy()](#copy) and [set()](#set) methods. **Examples:** ``` $m = Map::from( ['a' => 1] ); $m->with( 2, 'b' ); // ['a' => 1, 2 => 'b'] $m->with( 'a', 2 ); // ['a' => 2] $m->all(); // ['a' => 1] ``` **See also:** - [set()](#set) - Sets an element in the map by key without returning a new map ### zip() [](#zip) Merges the values of all arrays at the corresponding index. ``` public function zip( $array1, ... ) : self ``` - @param **array<int|string,mixed>|\\Traversable<int|string,mixed>|\\Iterator<int|string,mixed>** `$array1` List of arrays to merge with at the same position - @return **self<int|string,mixed>** New map of arrays **Examples:** ``` Map::from( [1, 2, 3] )->zip( ['one', 'two', 'three'], ['uno', 'dos', 'tres'] ); /* [ [1, 'one', 'uno'], [2, 'two', 'dos'], [3, 'three', 'tres'], ] */ ``` **See also:** - [combine()](#combine) - Combines the values of the map as keys with the passed elements as values Custom methods -------------- [](#custom-methods) Most of the time, it's enough to pass an anonymous function to the [pipe()](#pipe) method to implement custom functionality in map objects: ``` Map::from( ['a', 'b'] )->pipe( function( $map ) { return strrev( $map->join( '-' ) ); } ); ``` If you need some functionality more often and at different places in your source code, than it's better to register a custom method once and only call it everywhere: ``` Map::method( 'strrev', function( $sep ) { return strrev( join( '-', $this->list() ) ); } ); Map::from( ['a', 'b'] )->strrev( '-' ); ``` Make sure, you register the method before using it. You can pass arbitrary parameters to your function and it has access to the internas of the map. Thus, your function can use `$this` to call all available methods: ``` Map::method( 'notInBoth', function( iterable $elements ) { return new self( $this->diff( $elements ) + Map::from( $elements )->diff( $this->items ) ); } ); ``` Your custom method has access to `$this->items` array which contains the map elements and can also use the internal `$this->getArray( iterable $list )` method to convert iterable parameters (arrays, generators and objects implementing \\Traversable) to plain arrays: ``` Map::method( 'mycombine', function( iterable $keys ) { return new self( array_combine( $this->getArray( $keys ), $this-items ) ); } ); ``` Performance ----------- [](#performance) The performance most methods only depends on the array\_\* function that are used internally by the Map class. If the methods of the Map class contains additional code, it's optimized to be as fast as possible. ### Creating Map vs. array [](#creating-map-vs-array) Creating an map object with an array instead of creating a plain array only is significantly slower (ca. 10x) but in absolute values we are talking about nano seconds. It will only get notable if you create 10,000 map objects instead of 10,000 arrays. Then, creating maps will last ca. 10ms longer. Usually, this isn't much of a problem because applications create arrays with lots of elements instead of 10,000+ arrays. Nevertheless, if your application creates a very large number of arrays within one area, you should think about avoiding map objects in that area. If you use the [map()](#map-function) function or [Map::from()](#from) to create map objects, then be aware that this adds another function call. Using these methods for creating the map object lasts around 1.1x resp. 1.3x compared to the time for `new Map()`. Conclusion: Using `new Map()` is fastest and `map()` is faster than `Map::from()`. ### Populating Map vs. array [](#populating-map-vs-array) Adding an element to a Map object using `$map[] = 'a'` is ca. 5x slower than doing the same on a plain array. This is because the method [offsetSet()](#offsetset) will be called instead of adding the new element to the array directly. This applies to the `$map->push( 'a' )` method too. When creating arrays in loops, you should populate the array first and then create a Map object from the the array: ``` $list = []; for( $i = 0; $i < 1000; $i++ ) { $list[] = $i; } $map = map( $list ); ``` The array is **NOT** copied when creating the Map object so there's virtually no performance loss using the Map afterwards. ### Using Map methods vs. language constructs [](#using-map-methods-vs-language-constructs) Language constructs such as `empty()`, `count()` or `isset()` are faster than calling a method and using `$map->isEmpty()` or `$map->count()` is ca. 4x slower. Again, we are talking about nano seconds. For 10,000 calls to `empty( $array )`compared to `$map->isEmpty()`, the costs are around 4ms in total. ### Using Map methods vs. array\_\* functions [](#using-map-methods-vs-array_-functions) Using the Map methods instead of the array\_\* functions adds an additional method call. Internally, the Map objects uses the same array\_\* functions but offers a much more usable interface. The time for the additional method call is almost neglectable because the array\_\* methods needs much longer to perform the operation on the array elements depending on the size of the array. ### Using anonymous functions [](#using-anonymous-functions) Several Map methods support passing an anonymous function that is applied to every element of the map. PHP needs some time to call the passed function and to execute its code. Depending on the number of elements, this may have a significant impact on performance! The [pipe()](#pipe) method of the Map object is an exception because it receives the whole map object instead of each element separately. Its performance mainly depends on the implemented code: ``` $map->pipe( function( Map $map ) { // perform operations on the map } ); ``` ### Using shift() and unshift() [](#using-shift-and-unshift) Both methods are costly, especially on large arrays. The used `array_shift()` and `array_unshift()` functions will reindex all numerical keys of the array. If you want to reduce or create a large list of elements from the beginning in an iterative way, you should use [reverse()](#reverse) and [pop()](#pop)/[push()](#push)instead of [shift()](#shift) and [unshift()](#unshift)/[prepend()](#prepend): ``` $map->reverse()->pop(); // use pop() until it returns NULL $map->push( 'z' )->push( 'y' )->push( 'x' )->reverse(); // use push() for adding ``` Upgrade guide ------------- [](#upgrade-guide) ### 2.x -> 3.x [](#2x---3x) #### Use list() method [](#use-list-method) When adding own methods to the Map object, don't access the `$this->list` class variable directly. It's not guaranteed to be an array any more but will store the value passed to the Map constructor. Instead, use the `list() method to get a reference to the array of elements: ``` $this->list(); ``` As it's a reference to the array of elements, you can modify it directly or even use PHP functions that require a variable reference: ``` $this->list()[] = 123; reset( $this->list() ); ``` #### Renamed internal methods [](#renamed-internal-methods) Two internal methods have been renamed and you have to use their new name if you have added own methods to the Map object: ``` // instead of $this->getArray( $array ) $this->array( $array ) // instead of $this->getValue( $entry, array $parts ) $this->val( $entry, array $parts ) ``` ### 1.x -> 2.x [](#1x---2x) #### jQuery style method calls [](#jquery-style-method-calls) You can call methods of objects in a map like this: ``` // MyClass implements setStatus() (returning $this) and getCode() (initialized by constructor) $map = Map::from( ['a' => new MyClass( 'x' ), 'b' => new MyClass( 'y' )] ); $map->setStatus( 1 )->getCode()->toArray(); ``` Before, it was checked if the objects really implement `setStatus()` and `getCode()`. This isn't the case any more to avoid returning an empty map if the method name is wrong or the called method is implemented using the `__call()` magic method. Now, PHP generates a fatal error if the method isn't implemented by all objects. #### Second equals() parameter [](#second-equals-parameter) The second parameter of the [equals()](#equals) method (`$assoc`) to compare keys too has been removed. Use the [is()](#is) method instead: ``` // 1.x map( ['one' => 1] )->equals( ['one' => 1], true ); // 2.x map( ['one' => 1] )->is( ['one' => 1] ); ``` #### New find() argument [](#new-find-argument) A default value or exception object can be passed to the [find()](#find) method now as second argument. The `$reverse` argument has been moved to the third position. ``` // 1.x Map::from( ['a', 'c', 'e'] )->find( function( $value, $key ) { return $value >= 'b'; }, true ); // 2.x Map::from( ['a', 'c', 'e'] )->find( function( $value, $key ) { return $value >= 'b'; }, null, true ); ``` #### groupBy() semantic change [](#groupby-semantic-change) If the key passed to [groupBy()](#groupby) didn't exist, the items have been grouped using the given key. Now, an empty string is used as key to offer easier checking and sorting of the keys. ``` Map::from( [ 10 => ['aid' => 123, 'code' => 'x-abc'], ] )->groupBy( 'xid' ); // 1.x [ 'xid' => [ 10 => ['aid' => 123, 'code' => 'x-abc'] ] ] // 2.x [ '' => [ 10 => ['aid' => 123, 'code' => 'x-abc'] ] ] ``` #### offsetExists() semantic change [](#offsetexists-semantic-change) To be consistent with typical PHP behavior, the [offsetExists()](#offsetexists) method use `isset()` instead of `array_key_exists()` now. This changes the behavior when dealing with NULL values. ``` $m = Map::from( ['foo' => null] ); // 1.x isset( $m['foo'] ); // true // 2.x isset( $m['foo'] ); // false ``` #### Renamed split() method [](#renamed-split-method) The static `Map::split()` method has been renamed to [Map::explode()](#explode) and the argument order has changed. This avoids conflicts with the Laravel split() method and is in line with the PHP `explode()` method. ``` // 1.x Map::split( 'a,b,c', ',' ); // 2.x Map::explode( ',', 'a,b,c' ); ``` ### Health Score 67 — FairBetter than 100% of packages Maintenance87 Actively maintained with recent releases Popularity62 Solid adoption and visibility Community26 Small or concentrated contributor base Maturity75 Established project with proven stability Bus Factor1 Top contributor holds 98.4% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~50 days Recently: every ~97 days Total 47 Last Release 52d ago Major Versions 1.0.x-dev → 2.0.02021-01-28 2.x-dev → 3.0.02022-03-02 3.x-dev → 4.x-dev2026-03-27 PHP version history (3 changes)1.0.0PHP ^7.1 1.10.2PHP ^7.1||^8.0 4.x-devPHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/ccdc84033584516c77fb6aa7f85dc7048f2fbcd08867fc6abf115d094bab5eef?d=identicon)[aimeos](/maintainers/aimeos) --- Top Contributors [![aimeos](https://avatars.githubusercontent.com/u/8647429?v=4)](https://github.com/aimeos "aimeos (504 commits)")[![scrutinizer-auto-fixer](https://avatars.githubusercontent.com/u/6253494?v=4)](https://github.com/scrutinizer-auto-fixer "scrutinizer-auto-fixer (5 commits)")[![liambaloh](https://avatars.githubusercontent.com/u/1364475?v=4)](https://github.com/liambaloh "liambaloh (3 commits)") --- Tags arraycollectionmapphpphp-arraysphp-mapphparraymapcollection ### Code Quality TestsPHPUnit Code StylePHP\_CodeSniffer ### Embed Badge ![Health badge](/badges/aimeos-map/health.svg) ``` [![Health](https://phpackages.com/badges/aimeos-map/health.svg)](https://phpackages.com/packages/aimeos-map) ``` ### Alternatives [graze/data-structure Data collections and containers 12287.4k8](/packages/graze-data-structure)[chdemko/sorted-collections Sorted Collections for PHP >= 8.2 222.5M3](/packages/chdemko-sorted-collections)[iteks/laravel-enum A comprehensive Laravel package providing enhanced enum functionalities, including attribute handling, select array conversions, and fluent facade interactions for robust enum management in Laravel applications. 2516.7k](/packages/iteks-laravel-enum) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)