Skip to content

Commit 296d055

Browse files
committed
chore: Added Map::entries() documentation
1 parent bac6d69 commit 296d055

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

docs/Map.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ primitive values) may be used as either a key or a value.
88
- [`Map() constructor`](#new-map)
99
- [`Map::clear()`](#mapclear)
1010
- [`Map::delete()`](#mapdelete)
11+
- [`Map::entries()`](#mapentries)
1112
- [`Map::get()`](#mapget)
1213
- [`Map::has()`](#maphas)
1314
- [`Map::keys()`](#mapkeys)
@@ -68,6 +69,20 @@ $myMap->delete(1);
6869
// false
6970
```
7071

72+
### Map::entries()
73+
74+
The `entries()` method returns a new `MapIterator` instance that contain pair `[key => value]` of each element of the Map.
75+
76+
```php
77+
$myMap = new Map(['foo' => 'bar']);
78+
79+
$iterator = $myMap->entries();
80+
// [object MapIterator]
81+
82+
$iterator->current();
83+
// ['foo' => 'bar']
84+
```
85+
7186
### Map::get()
7287

7388
The `get()` method returns a specified element from map.

0 commit comments

Comments
 (0)