関数・クラス解説

Collator::getSortKey

collator_get_sort_key

version:PHP 5 >= 5.3.2, PHP 7, PECL intl (公式)

文字列のソート用のキーを取得する

公式リファレンス

書式

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

collator_get_sort_key ( Collator $coll , string $str ) : string|false

説明

オブジェクト指向型

手続き型

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

パラメータ

coll
Collator オブジェクト。
str
キーの生成元となる文字列。

返値

文字列の照合キーを返します。失敗した場合に FALSE を返します 警告この関数は論理値FALSE を返す可能性がありますが、FALSE として評価される値を返す可能性もあります。詳細については 論理値のセクションを参照してください。この関数の返り値を調べるには===演算子 を使用してください。

注意

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

更新履歴

バージョン 説明
5.3.15, 5.4.5 ソート用のキーに NUL バイトは含まれなくなりました。

サンプル

例1 collator_get_sort_key() の例

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

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

3832404046010901dc08

参考

  • collator_sort() - 指定した collator で配列を並べ替える
  • collator_sort_with_sort_keys() - 指定した collator とキーで配列を並べ替える
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール