Collator::sortWithSortKeys

collator_sort_with_sort_keys

(PHP 5 >= 5.3.0, PHP 7, PHP 8, PECL intl >= 1.0.0)

Collator::sortWithSortKeys -- collator_sort_with_sort_keys — 指定した collator とキーで配列を並べ替える

説明

オブジェクト指向型

public function Collator::sortWithSortKeys(array &$array): bool

手続き型

function collator_sort_with_sort_keys(Collator $object, array &$array): bool

collator_sort() と似ていますが、 ucol_getSortKey() が作成した ICU ソートキーを用いることで大きな配列をより高速に処理できます。

パラメータ

object: Collator オブジェクト。
array: 並べ替えたい文字列の配列。

戻り値

成功した場合に true を、失敗した場合に false を返します。

例

例1 collator_sort_with_sort_keys() の例

<?php
$arr  = array( 'Köpfe', 'Kypper', 'Kopfe' );
$coll = collator_create( 'sv' );

collator_sort_with_sort_keys( $coll, $arr );
var_export( $arr );
?>

上の例の出力は以下となります。

array (
  0 => 'Kopfe',
  1 => 'Kypper',
  2 => 'Köpfe',
)

参考

Collator の定数
collator_sort() - 指定した collator で配列を並べ替える
collator_asort() - インデックスの情報を保持しつつ配列を並べ替える

関連キーワード:

collator sort Collator keys キー sortWithSortKeys Köpfe Kypper Kopfe coll NumberFormatter intl オブジェクト指向手続き ucol getSortKey ソートキー高速成功 create export 参考定数 asort インデックス