Sequence
PHP Manual

Ds\Sequence::first

(PECL ds >= 1.0.0)

Ds\Sequence::firstReturns the first value in the sequence.

Description

abstract public mixed Ds\Sequence::first ( void )

Returns the first value in the sequence.

Parameters

This function has no parameters.

Return Values

The first value in the sequence.

Errors/Exceptions

UnderflowException if empty.

Examples

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

<?php
$sequence 
= new \Ds\Vector([123]);
var_dump($sequence->first());
?>

The above example will output something similar to:

int(1)

Sequence
PHP Manual