Collator::asort

collator_asort

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

Collator::asort -- collator_asort — インデックスの情報を保持しつつ配列を並べ替える

説明

オブジェクト指向型

public function Collator::asort(array &$array, int $flags = Collator::SORT_REGULAR): bool

手続き型

function collator_asort(Collator $object, array &$array, int $flags = Collator::SORT_REGULAR): bool

この関数は、インデックスと値の関係を保持したうえで配列を並べ替えます。これを主に使用するのは、実際の並び順も重要となる連想配列です。配列の要素には、現在のロケールの規則にしたがった並び順が適用されます。

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

パラメータ

object

Collator オブジェクト。

array

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

flags

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

Collator::SORT_REGULAR - 通常の比較 (型を変更しない)
Collator::SORT_NUMERIC - 数値としての比較
Collator::SORT_STRING - 文字列としての比較

デフォルトの flags の値は Collator::SORT_REGULAR です。 flags に無効な値が指定された場合も、このデフォルトを使用します。

戻り値

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

例

例1 collator_asort() の例

<?php
$coll = collator_create( 'en_US' );
$arr = array(
     'a' => '100',
     'b' => '50',
     'c' => '7'
);
collator_asort( $coll, $arr, Collator::SORT_NUMERIC );
var_export( $arr );

collator_asort( $coll, $arr, Collator::SORT_STRING );
var_export( $arr );
?>

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

array (
  'c' => '7',
  'b' => '50',
  'a' => '100',
)array (
  'a' => '100',
  'b' => '50',
  'c' => '7',
)

参考

Collator の定数
collator_sort() - 指定した collator で配列を並べ替える
collator_sort_with_sort_keys() - 指定した collator とキーで配列を並べ替える

関連キーワード:

Collator collator asort flags インデックス保持 coll sort 並び順 export compare intl オブジェクト指向手続き関係実際連想ロケール規則適用並べ替え方式通常数値無効