uasort()

Sorting Arrays in PHP with uasort()

At the heart of most programming tasks lies the need to sort data. Sorting data enables you to access and display it more efficiently, which can save you time and resources in the long run. In PHP, you can sort arrays using the built-in uasort() function.

In this article, we will explore the uasort() function, its syntax, and the various parameters it accepts. We will also take a deep dive into how this function can be used to sort arrays in PHP, and provide examples of practical applications of this powerful function.

What is uasort()?

uasort() is a built-in PHP function that is used to sort arrays in a user-defined way. It sorts an array by applying a user-defined comparison function to each element of the array, in a way that preserves the relationship between keys and values. The function then reorders the elements in the array based on the result of the comparison function.

This function is particularly useful when you need to sort associative arrays or multidimensional arrays, as it allows you to specify which values to compare and how to compare them.

Syntax of uasort()

The syntax of uasort() is as follows:

Syntax of uasort()

uasort(array &$array, callable $comparison_function): bool

Let's break down the various parts of this syntax:

• array &$array: This is the array to be sorted. The & symbol before the $array variable indicates that this is a reference to the original array, which means that any changes made to the sorted array will also be reflected in the original array.
• callable $comparison_function: This is the comparison function to be applied to the array elements. The comparison function should take two arguments, $a and $b, which represent the elements being compared. The function should return an integer that indicates the relationship between $a and $b.
• bool: This is the return type of the uasort() function. It returns true on success and false on failure.

Parameters of the comparison function

The comparison function used in uasort() must return an integer that indicates the relationship between two values. The function must take two arguments, $a and $b, which represent the elements being compared. The return value should be as follows:

• If $a is greater than $b, the function should return a positive integer.
• If $a is equal to $b, the function should return 0.
• If $a is less than $b, the function should return a negative integer.

Examples of uasort()

Let's explore some examples of how uasort() can be used to sort arrays in PHP.

Example 1: Sorting a simple array

Suppose we have the following array:

A PHP Array

$array = array(3, 1, 4, 1, 5, 9, 2, 6, 5, 3);

To sort this array in ascending order, we can use the following comparison function:

Sorting an array in PHP

function compare($a, $b) {
    return ($a < $b) ? -1 : 1;
}

We can then call the uasort() function as follows:

Sorting a simple array using uasort() function

<?php

$array = [3, 1, 4, 1, 5, 9, 2, 6, 5, 3];

function compare($a, $b)
{
    return $a < $b ? -1 : 1;
}

uasort($array, "compare");

print_r($array);

This will sort the array in ascending order, as follows:

Array
(
    [3] => 1
    [1] => 1
    [6] => 2
    [9] => 3
    [0] => 3
    [2] => 4
    [8] => 5
    [4] => 5
    [7] => 6
    [5] => 9
)

Example 2: Sorting an associative array by value

Suppose we have the following associative array:

A PHP associative array

$array = array(
    "John" => 32,
    "Mary" => 28,
    "Bob" => 45,
    "Jane" => 28,
    "David" => 37
);

To sort this array by value in ascending order, we can use the following comparison function:

Sorting an array in PHP by using a comparison functio

function compare($a, $b) {
    if ($a == $b) {
        return 0;
    }
    return ($a < $b) ? -1 : 1;
}

We can then call the asort() function as follows:

Sorting an associative array by value using uasort() function in PHP

<?php

$array = [
    "John" => 32,
    "Mary" => 28,
    "Bob" => 45,
    "Jane" => 28,
    "David" => 37,
];

function compare($a, $b)
{
    if ($a == $b) {
        return 0;
    }
    return $a < $b ? -1 : 1;
}

uasort($array, "compare");

print_r($array);

This will sort the array by value in ascending order, as follows:

array(
    "Mary" => 28,
    "Jane" => 28,
    "John" => 32,
    "David" => 37,
    "Bob" => 45
);

Example 3: Sorting a multidimensional array by value

Suppose we have the following multidimensional array:

A multidimensional array in PHP

<?php

$array = [["John", 32], ["Mary", 28], ["Bob", 45], ["Jane", 28], ["David", 37]];

To sort this array by the second value in each sub-array in ascending order, we can use the following comparison function:

Sorting an array by the second value in each sub-array in PHP by using a comparison function

function compare($a, $b) {
    if ($a[1] == $b[1]) {
        return 0;
    }
    return ($a[1] < $b[1]) ? -1 : 1;
}

We can then call the uasort() function as follows:

Example of Sorting a multidimensional array by value in PHP

<?php

$array = [["John", 32], ["Mary", 28], ["Bob", 45], ["Jane", 28], ["David", 37]];

function compare($a, $b) {
    if ($a[1] == $b[1]) {
        return 0;
    }
    return ($a[1] < $b[1]) ? -1 : 1;
}

uasort($array, "compare");

print_r($array);

This will sort the array by the second value in each sub-array in ascending order, as follows:

Array
(
    [1] => Array
        (
            [0] => Mary
            [1] => 28
        )

    [3] => Array
        (
            [0] => Jane
            [1] => 28
        )

    [0] => Array
        (
            [0] => John
            [1] => 32
        )

    [4] => Array
        (
            [0] => David
            [1] => 37
        )

    [2] => Array
        (
            [0] => Bob
            [1] => 45
        )

)

Conclusion

Sorting arrays is an essential task in many programming applications, and PHP provides a powerful function for sorting arrays in a user-defined way. By using the uasort() function, you can sort arrays in PHP with ease, and even sort associative arrays and multidimensional arrays. By understanding the syntax and parameters of this function, you can take advantage of its power to efficiently sort data in your PHP applications.

Practice