IEnumerable.elementAtOrDefault() method

IEnumerable->elementAtOrDefault($index [, $defValue]) method

Returns a value at a specific position or a default value if not found (s. ElementAtOrDefault()).

Syntax

public function elementAtOrDefault(int $index
                                   [, mixed $defValue = null ]) : mixed;

Parameters

Name	Type	Description
$index	int	The zero-based index.
$defValue	mixed	[OPTIONAL] The value to return if element was not found.

$index

The zero based index.

$defValue

Is returned if element was not found.

Result

The value / default value.

Examples

In range

use \System\Linq\Enumerable;

$seq = Enumerable::fromValues(1, 2, 3);

// 2
$res = $seq->elementAtOrDefault(1, 'TM');

Empty

use \System\Linq\Enumerable;

$seq = Enumerable::fromValues();

// 'TM'
$res = $seq->elementAtOrDefault(1, 'TM');

Out of range

use \System\Linq\Enumerable;

$seq = Enumerable::fromValues(1, 2, 3);

// (false)
$res = $seq->elementAtOrDefault(3, false);