Ds\Map::sorted
Ds\Map::sorted
(PECL ds >= 1.0.0)
Ds\Map::sorted — Returns a copy, sorted by value.
Description
public Ds\Map Ds\Map::sorted ([ callable $comparator ] )
Returns a copy, sorted by value using an optional comparator
function.
Parameters
-
comparator
-
The comparison function must return an integer less than, equal to, or greater than zero if the first argument is considered to be respectively less than, equal to, or greater than the second. Note that before PHP 7.0.0 this integer had to be in the range from -2147483648 to 2147483647.
int callback ( mixed $a, mixed $b )
Return Values
Returns a copy of the map, sorted by value.
Examples
Example #1 Ds\Map::sort() example
<?php $map = new \Ds\Map(["a" => 2, "b" => 3, "c" => 1]); print_r($map->sorted()); ?>
The above example will output something similar to:
Ds\Map Object ( [0] => Ds\Pair Object ( [key] => c [value] => 1 ) [1] => Ds\Pair Object ( [key] => a [value] => 2 ) [2] => Ds\Pair Object ( [key] => b [value] => 3 ) )
Example #2 Ds\Map::sort() example using a comparator
<?php $map = new \Ds\Map(["a" => 2, "b" => 3, "c" => 1]); // Reverse $sorted = $map->sorted(function($a, $b) { return $b <=> $a; }); print_r($sorted); ?>
The above example will output something similar to:
Ds\Map Object ( [0] => Ds\Pair Object ( [key] => b [value] => 3 ) [1] => Ds\Pair Object ( [key] => a [value] => 2 ) [2] => Ds\Pair Object ( [key] => c [value] => 1 ) )
© 1997–2017 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://secure.php.net/manual/en/ds-map.sorted.php