Ordena as entradas pela chave

# ArrayObject::ksort

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

ArrayObject::ksort — Ordena as entradas pela chave

### Descrição

public function ArrayObject::ksort(int `$flags` = `SORT_REGULAR`): true

Ordena as entradas pela chave, mantendo as correlações entre chave e entrada. Isso é útil principalmente para arrays associativos.

> Nota: Se dois elementos são comparados como iguais, eles mantêm sua ordem original. Antes do PHP 8.0.0, sua ordem relativa no array ordenado era indefinida.

### Parâmetros

`flags`
  O segundo parâmetro opcional `flags` pode ser usado para modificar o comportamento da ordenação usando estes valores:

  Flags dos tipos de ordenação:

  - `SORT_REGULAR` - compara os elementos normalmente; os detalhes são descritos na seção operadores de comparação
  - `SORT_NUMERIC` - compara os elementos numericamente
  - `SORT_STRING` - compara os elementos como strings
  - `SORT_LOCALE_STRING` - compara os elementos como strings, com base na localidade atual. A localidade pode ser alterada usando setlocale()
  - `SORT_NATURAL` - compara os elementos como strings usando "ordenação natural" como natsort()
  - `SORT_FLAG_CASE` - pode ser combinada (usando o operador bit a bit OR) com `SORT_STRING` ou `SORT_NATURAL` para ordenar strings sem fazer distinção entre maiúsculas e minúsculas

### Valor Retornado

Sempre retorna `true`.

### Registro de Alterações

Versão | Descrição
--- | ---
8.2.0 | O tipo do retorno agora é `true`; anteriormente, era bool.

### Exemplos

Exemplo #1 Exemplo de ArrayObject::ksort()

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

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

O exemplo acima produzirá:

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

### Veja Também

- ArrayObject::asort() - Ordenar as entradas por valor
- ArrayObject::natsort() - Ordena as entradas usando um algoritmo de "ordem natural"
- ArrayObject::natcasesort() - Ordena um array usando um algoritmo de "ordem natural" insensível a maiúsculas e minúsculas
- ArrayObject::uasort() - Ordena as entradas com uma função de comparação definida pelo usuário e mantém a associação de chaves
- ArrayObject::uksort() - Ordena as entradas pelas chaves usando uma função de comparação definida pelo usuário
- ksort() - Ordena um array pelas chaves em ordem crescente

`↑` and `↓` to navigate • `Enter` to select • `Esc` to close • `/` to open