IEnumerable.max() method

IEnumerable->max([ $defValue [, $comparer ]]) method

Gets the maximum value of that sequence (s. Max()).

Syntax

public function max([ mixed $defValue = null
                    [, comparer $comparer = null ]]) : mixed;

Parameters

Name	Type	Description
$defValue	mixed	[OPTIONAL] The value to return if sequence is empty.
$comparer	[[comparer	Comparer]]

$defValue

Is returned if sequence is empty.

$comparer

The custom comparer.

Result

The maximum value of the sequence or the default value.

Examples

Default

use \System\Linq;

$seq1 = Enumerable::fromValues(239, 5979, 1);
$seq2 = Enumerable::create();

// 5979
$a1 = $seq1->max('YS');

// 'YS', because no element found
$a2 = $seq2->max('YS');

Custom comparer (lambda expression)

use \System\Linq;

class MyComparableClass {
    public $SortValue;

    public function __construct($sortVal) {
        $this->SortValue = $sortVal;
    }
}

$seq1 = Enumerable::fromValues(new MyComparableClass(5979),
                               new MyComparableClass(1),
                               new MyComparableClass(239));
$seq2 = Enumerable::create();

$comparer = '($x, $y) => $x->SortValue - $y->SortValue';

// instance of MyComparableClass
// with $a1->SortValue = 5979
$a1 = $seq1->max('PZ', $comparer);

// 'PZ', because no element found
$a2 = $seq2->max('PZ', $comparer);

Custom comparer (closure)

use \System\Linq;

class MyComparableClass {
    public $SortValue;

    public function __construct($sortVal) {
        $this->SortValue = $sortVal;
    }
}

$seq1 = Enumerable::fromValues(new MyComparableClass(5979),
                               new MyComparableClass(1),
                               new MyComparableClass(239));
$seq2 = Enumerable::create();

$comparer = function(MyComparableClass $x, MyComparableClass $y) {
                return $x->SortValue - $y->SortValue;
            };

// instance of MyComparableClass
// with $a1->SortValue = 5979
$a1 = $seq1->max('MK', $comparer);

// 'MK', because no element found
$a2 = $seq2->max('MK', $comparer);