Collator::asort

collator_asort

Sort array maintaining index association

&reftitle.description;

&style.oop;

public `bool` `Collator::asort` `array` `array` `int` `flags` Collator::SORT_REGULAR

&style.procedural;

`bool` `collator_asort` `Collator` `object` `array` `array` `int` `flags` Collator::SORT_REGULAR

This function sorts an array such that array indices maintain their correlation with the array elements they are associated with. This is used mainly when sorting associative arrays where the actual element order is significant. Array elements will have sort order according to current locale rules.

Equivalent to standard PHP `asort`.

&reftitle.parameters;

`object`

- `Collator` object.

`array`

- Array of strings to sort.

`flags`

- Optional sorting type, one of the following:

  - `Collator::SORT_REGULAR` - compare items normally (don't change types)

  - `Collator::SORT_NUMERIC` - compare items numerically

  - `Collator::SORT_STRING` - compare items as strings

  Default `flags` value is `Collator::SORT_REGULAR`. It is also used if an invalid `flags` value has been specified.

&reftitle.returnvalues;

&return.success;

&reftitle.examples;

### `collator_asort` example

    <?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 );
    ?>

&example.outputs;

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

&reftitle.seealso;

- `Collator` constants
- `collator_sort`
- `collator_sort_with_sort_keys`