PHP Manual
SplHeap
Сравнивает элементы, чтобы во время сортировки корректно разместить их в куче

SplHeap::compare

(PHP 5 >= 5.3.0, PHP 7)

SplHeap::compare — Сравнивает элементы, чтобы во время сортировки корректно разместить их в куче

Описание

abstract protected SplHeap::compare ( mixed $value1 , mixed $value2 ) : int

Сравнивает value1 с value2.

Внимание

Выбрасывание исключений в методе SplHeap::compare() может нарушить целостность кучи и перевести ее в заблокированное состояние. Разблокировать кучу можно методом SplHeap::recoverFromCorruption(). Однако, некоторые элементы могут быть помещены некорректно, что нарушит сортировку внутри кучи.

Список параметров

value1: Значение первого сравниваемого узла.
value2: Значение второго сравниваемого узла.

Возвращаемые значения

Метод должен возвращать положительное значение, когда value1 больше value2, 0 если они равны, и отрицательное в остальных случаях.

Замечание:
Помещению в кучу одинаковых элементов нежелательно, так как невозможно будет отследить точное положение конкретного элемента.