php8.5
Home/ Manual/ ds / map/ Ds\Map::sum

Ds\Map::sum

PHP function Edit on GitHub ✎

Returns the sum of all values in the map

Description

Ds\Map::sum(): int|float

Returns the sum of all values in the map.

Note

Arrays and objects are considered equal to zero when calculating the sum.

Parameters Parameters

Return Values

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

Examples

Ds\Map::sum() integer example

php
<?php
$map = new \Ds\Map(["a" => 1, "b" => 2, "c" => 3]);
var_dump($map->sum());
?>

The above example will output something similar to:

output
int(6)

Ds\Map::sum() float example

php
<?php
$map = new \Ds\Map(["a" => 1, "b" => 2.5, "c" => 3]);
var_dump($map->sum());
?>

The above example will output something similar to:

output
float(6.5)

Source: reference/ds/ds/map/sum.xml · from the official PHP manual (php/doc-en)