Collator::getSortKey

collator_get_sort_key

(PHP 5 >= 5.3.2, PHP 7, PHP 8, PECL intl >= 1.0.3)

Collator::getSortKey -- collator_get_sort_key — 文字列のソート用のキーを取得する

説明

オブジェクト指向型

public Collator::getSortKey(string $string): string|false

手続き型

collator_get_sort_key(Collator $object, string $string): string|false

文字列用の照合キーを返します。 照合キーは文字列のかわりに直接比較することができますが、 これは実装依存の動きであり、ICUライブラリのバージョンによって変わる可能性があります。 一般的に、ソート用のキーはデータベース内部か、関数呼び出しコストがとても高い状況でのみ役に立ちます。

パラメータ

object

Collator オブジェクト。

string

キーの生成元となる文字列。

戻り値

文字列の照合キーを返します。失敗した場合に false を返します

警告

この関数は論理値 false を返す可能性がありますが、false として評価される値を返す可能性もあります。 詳細については 論理値の セクションを参照してください。この関数の返り値を調べるには ===演算子 を 使用してください。

例

例1 collator_get_sort_key() の例

<?php
$s1 = 'Hello';

$coll = collator_create('en_US');
$res  = collator_get_sort_key($coll, $s1);

echo bin2hex($res);
?>

上の例の出力は、 たとえば以下のようになります。


3832404046010901dc08

参考

関連キーワード: 　キー, ソート, Collator, collator, 取得, string, sort, key, 関数, getSortKey