ScotlandPHP

Ds\Map::first

(PECL ds >= 1.0.0)

Ds\Map::firstReturns the first pair in the map.

Description

public Ds\Pair Ds\Map::first ( void )

Returns the first pair in the map.

Parameters

This function has no parameters.

Return Values

The first pair in the map.

Errors/Exceptions

UnderflowException if empty.

Examples

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

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

The above example will output something similar to:

object(Ds\Pair)#2 (2) {
  ["key"]=>
  string(1) "a"
  ["value"]=>
  int(1)
}
add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top