ArrayObject::asort

(PHP 5 >= 5.2.0, PHP 7, PHP 8)

ArrayObject::asort値でエントリをソートする

説明

public ArrayObject::asort(int $flags = SORT_REGULAR): bool

エントリを昇順にソートします。 キーとそれに対応する値の関連は保持されたままとなります。

これは主に、連想配列など実際の要素の並びが重要となる場合のソートで使います。

パラメータ

flags

オプションの第二引数 flags によりソートの動作を修正可能です。 使える値は下記の通りです:

ソートタイプのフラグ:

  • SORT_REGULAR - 通常通りに項目を比較します。 詳細は 比較演算子 で説明されています。
  • SORT_NUMERIC - 数値として項目を比較します。
  • SORT_STRING - 文字列として項目を比較します。
  • SORT_LOCALE_STRING - 現在のロケールに基づいて、文字列として項目を比較します。 比較に使うロケールは、setlocale() 関数で変更できます。
  • SORT_NATURAL - 要素の比較を文字列として行い、 natsort() と同様の「自然順」で比較します。
  • SORT_FLAG_CASE - SORT_STRINGSORT_NATURAL と (ビットORで) 組み合わせて使い、 文字列のソートで大文字小文字を区別しないようにします。

戻り値

常に true を返します。

例1 ArrayObject::asort() の例

<?php
$fruits 
= array("d" => "lemon""a" => "orange""b" => "banana""c" => "apple");
$fruitArrayObject = new ArrayObject($fruits);
$fruitArrayObject->asort();

foreach (
$fruitArrayObject as $key => $val) {
    echo 
"$key = $val\n";
}
?>

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

c = apple
b = banana
d = lemon
a = orange

フルーツがアルファベット順で並べ替えられ、 各エントリに対応するキーもそれにあわせて並べ替えられます。

参考

  • ArrayObject::ksort() - キーでエントリをソートする
  • ArrayObject::natsort() - "自然順" アルゴリズムでエントリをソートする
  • ArrayObject::natcasesort() - 大文字小文字を区別しない "自然順" アルゴリズムでエントリをソートする
  • ArrayObject::uasort() - ユーザー定義の比較関数でエントリをソートし、キーとの対応は保持する
  • ArrayObject::uksort() - ユーザー定義の比較関数を使って、キーでエントリをソートする
  • asort() - 連想キーと要素との関係を維持しつつ配列を昇順にソートする

関連キーワード:  ソート, エントリ, ArrayObject, 比較, キー, , asort, 関数, flags, 対応