1. class
  2. ExeQue
  3. \
  4. Remix
  5. \
  6. Mutate
  7. \
  8. Array
  9. \
  10. Sort

Sort

class Sort extends ArrayMutator (View source)

Sorts an array. The callback is used to retrieve the value to sort by. If no callback is provided, the value itself is used.

Preserves key association by default. To reset key association, set $preserveKeys to false.

Supports built-in PHP sorting flags. See https://www.php.net/manual/en/function.sort.php for more information.

Methods

__construct(SortDirection $direction = SortDirection::Asc, callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

No description

mixed
__invoke(mixed $value)

Mutate the input value.

from  Mutator
static Sort
asc(callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

Sorts an array in ascending order.

static Sort
desc(callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

Sorts an array in descending order.

static Sort
make(SortDirection $direction = SortDirection::Asc, callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

No description

mixed
mutate(mixed $value)

Mutate the input value.

from  ArrayMutator
array
mutateArray(array $array)

No description

Details

at line 31
__construct(SortDirection $direction = SortDirection::Asc, callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

No description

Parameters

SortDirection $direction

The direction to sort by (optional, default: SortDirection::Asc)
callable $callback

The callback to retrieve the value to sort by (optional)
bool $preserveKeys

Whether to preserve key association (default: true)
int $flags

Flags to pass to the PHP sort function (default: SORT_REGULAR)

in Mutator at line 9
final mixed __invoke(mixed $value)

Mutate the input value.

Parameters

mixed $value

Return Value

mixed

at line 57
static Sort asc(callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

Sorts an array in ascending order.

Parameters

callable $callback

The callback to retrieve the value to sort by (optional)
bool $preserveKeys

Whether to preserve key association (default: true)
int $flags

Flags to pass to the PHP sort function (default: SORT_REGULAR)

Return Value

Sort

at line 69
static Sort desc(callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

Sorts an array in descending order.

Parameters

callable $callback

The callback to retrieve the value to sort by (optional)
bool $preserveKeys

Whether to preserve key association (default: true)
int $flags

Flags to pass to the PHP sort function (default: SORT_REGULAR)

Return Value

Sort

at line 45
static Sort make(SortDirection $direction = SortDirection::Asc, callable $callback = null, bool $preserveKeys = true, int $flags = SORT_REGULAR)

No description

Parameters

SortDirection $direction

The direction to sort by (optional, default: SortDirection::Asc)
callable $callback

The callback to retrieve the value to sort by (optional)
bool $preserveKeys

Whether to preserve key association (default: true)
int $flags

Flags to pass to the PHP sort function (default: SORT_REGULAR)

Return Value

Sort

in ArrayMutator at line 12
mixed mutate(mixed $value)

Mutate the input value.

Parameters

mixed $value

Return Value

mixed

at line 74
protected array mutateArray(array $array)

No description

Parameters

array $array

Return Value

array