ArrayObject::asort

ArrayObject::asort

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

ArrayObject::asort — Sort the entries by value

Description

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

Sorts the entries in ascending order, such that its keys maintain their correlation with the values they are associated with.

This is used mainly when sorting associative arrays where the actual element order is significant.

Note:

If two members compare as equal, they retain their original order. Prior to PHP 8.0.0, their relative order in the sorted array was undefined.

Parameters

flags

The optional second parameter flags may be used to modify the sorting behavior using these values:

Sorting type flags:

• SORT_REGULAR - compare items normally; the details are described in the comparison operators section
• SORT_NUMERIC - compare items numerically
• SORT_STRING - compare items as strings
• SORT_LOCALE_STRING - compare items as strings, based on the current locale. It uses the locale, which can be changed using setlocale()
• SORT_NATURAL - compare items as strings using "natural ordering" like natsort()
• SORT_FLAG_CASE - can be combined (bitwise OR) with SORT_STRING or SORT_NATURAL to sort strings case-insensitively

Return Values

Always returns true.

Examples

Example #1 ArrayObject::asort() example

<?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";
}
?>

The above example will output:

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

The fruits have been sorted in alphabetical order, and the key associated with each entry has been maintained.

See Also

• ArrayObject::ksort() - Sort the entries by key
• ArrayObject::natsort() - Sort entries using a "natural order" algorithm
• ArrayObject::natcasesort() - Sort an array using a case insensitive "natural order" algorithm
• ArrayObject::uasort() - Sort the entries with a user-defined comparison function and maintain key association
• ArrayObject::uksort() - Sort the entries by keys using a user-defined comparison function
• asort() - Sort an array in ascending order and maintain index association

© 1997–2020 The PHP Documentation Group
Licensed under the Creative Commons Attribution License v3.0 or later.
https://www.php.net/manual/en/arrayobject.asort.php