Util

インタフェース: Peach_Util_Comparator

定義: /Peach/Util/Comparator.php

与えられた二つの値を比較するインタフェースです.

このインタフェースは, Peach_Util_Arrays::sort() の引数として使われます. Java における java.util.Comparator と同じ用途で使われることを想定しています.

PHP には同様の働きをする usort() などのビルトイン関数がありますが, ユーザ定義関数にメンバメソッド (クラスメソッドではなく) を利用する仕組みがないため, 必要に応じてこのインタフェースを利用してください.

メソッド

メソッド 詳細

compare

line 56

int compare(mixed $var1, mixed $var2)

二つの値を比較します.

$var1 が $var2 より小さい場合は負の整数, $var1 が $var2 より大きい場合は正の整数, $var1 と $var2 が等しい場合は 0 を返します.

もし $var1 と $var2 が比較できない場合は NULL を返すか, 任意の例外をスローします.

Tags

  • return : 比較した結果, $var1 > $var1 の場合は正, $var2 > $var1 の場合は負, $var1 == $var2 の場合は 0
  • access : public

引数

mixed   $var1   比較対象の値
mixed   $var2   比較対象の値