Collator::sort

collator_sort

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

Collator::sort -- collator_sort — 指定した collator で配列を並べ替える

説明

オブジェクト指向型

public Collator::sort ( array &$arr [, int $sort_flag ] ) : bool

手続き型

collator_sort ( Collator $coll , array &$arr [, int $sort_flag ] ) : bool

この関数は、現在のロケールの規則にもとづいて配列を並べ替えます。

PHP の標準関数 sort() と同等です。

パラメータ

coll

Collator オブジェクト。

arr

並べ替えたい文字列の配列。

sort_flag

オプションの並べ替え方式。以下のいずれか。

  • Collator::SORT_REGULAR - 通常の比較 (型を変更しない)

  • Collator::SORT_NUMERIC - 数値としての比較

  • Collator::SORT_STRING - 文字列としての比較

デフォルトの並べ替え方式は Collator::SORT_REGULAR です。sort_flag に無効な値を指定した場合もこの方式を使います。

返り値

成功した場合に TRUE を、失敗した場合に FALSE を返します。

例

例1 collator_sort() の例

<?php
$coll = collator_create( 'en_US' );
$arr  = array( 'at', 'às', 'as' );

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

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

array (
  0 => 'at',
  1 => 'às',
  2 => 'as',
)array (
  0 => 'as',
  1 => 'às',
  2 => 'at',
)

参考