Ds\Map::get

(PECL ds >= 1.0.0)

Ds\Map::get — Returns the value for a given key

Description

public Ds\Map::get ( mixed $key [, mixed $default ] ) : mixed

Returns the value for a given key, or an optional default value if the key could not be found.

Note:
Keys of type object are supported. If an object implements Ds\Hashable, equality will be determined by the object's equals function. If an object does not implement Ds\Hashable, objects must be references to the same instance to be considered equal.

Note:
You can also use array syntax to access values by key, eg. $map["key"].

Caution

Be careful when using array syntax. Scalar keys will be coerced to integers by the engine. For example, $map["1"] will attempt to access int(1), while $map->get("1") will correctly look up the string key.

See Arrays.

PHP: Ds\Map::get - Manual Home of Manuel PHP Contents Haut

Parameters

key: The key to look up.
default: The optional default value, returned if the key could not be found.

PHP: Ds\Map::get - Manual Home of Manuel PHP Contents Haut

Return Values

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

PHP: Ds\Map::get - Manual Home of Manuel PHP Contents Haut

Errors/Exceptions

OutOfBoundsException if the key could not be found and a default value was not provided.

PHP: Ds\Map::get - Manual Home of Manuel PHP Contents Haut

Examples

Example #1 Ds\Map::get() example


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

var_dump($map->get("a"));       // 1
var_dump($map->get("d", 10));   // 10 (default used)
?>

The above example will output something similar to:

int(1)
int(10)

Example #2 Ds\Map::get() example using array syntax


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

var_dump($map["a"])); // 1
?>

The above example will output something similar to:

int(1)

Find a PHP function

English translation

You have asked to visit this site in English. For now, only the interface is translated, but not all the content yet.

If you want to help me in translations, your contribution is welcome. All you need to do is register on the site, and send me a message asking me to add you to the group of translators, which will give you the opportunity to translate the pages you want. A link at the bottom of each translated page indicates that you are the translator, and has a link to your profile.

Thank you in advance.

Document created the 30/01/2003, last modified the 26/10/2018
Source of the printed document:https://www.gaudry.be/en/php-rf-ds-map.get.html

The infobrol is a personal site whose content is my sole responsibility. The text is available under CreativeCommons license (BY-NC-SA). More info on the terms of use and the author.

References

Manuel PHP : http://php.net

These references and links indicate documents consulted during the writing of this page, or which may provide additional information, but the authors of these sources can not be held responsible for the content of this page.
The author This site is solely responsible for the way in which the various concepts, and the freedoms that are taken with the reference works, are presented here. Remember that you must cross multiple source information to reduce the risk of errors.

Contents Haut