Collator::sort

collator_sort

Sort array using specified collator

&reftitle.description;

&style.oop;

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

&style.procedural;

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

This function sorts an array according to current locale rules.

Equivalent to standard PHP `sort` .

&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 sorting type is `Collator::SORT_REGULAR`. It is also used if an invalid `flags` value has been specified.
&reftitle.returnvalues;

&return.success;

&reftitle.examples;

### `collator_sort` example

    <?php
    $coll = collator_create( 'en_US' );
    $arr  = array( 'at', 'às', 'as' );

    var_export( $arr );
    collator_sort( $coll, $arr );
    var_export( $arr );
    ?>

&example.outputs;

    array (
      0 => 'at',
      1 => 'às',
      2 => 'as',
    )array (
      0 => 'as',
      1 => 'às',
      2 => 'at',
    )

&reftitle.seealso;

- `Collator` constants
- `collator_asort`
- `collator_sort_with_sort_keys`