Ipl\IteratorPipeline\Traits\SortingTrait

Complexity

Total Complexity

3

Size/Duplication

Total Lines	43
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	sort()	0	3	1
A	reverse()	0	3	1
A	sortKeys()	0	3	1

<?php

declare(strict_types=1);

namespace Ipl\IteratorPipeline\Traits;

use Ipl as i;

/**
 * Methods that change the order of the elements.
 */
trait SortingTrait
{
    /**
     * Define the next step via a callback that returns an array or Traversable object.
     *
     * @param callable $callback
     * @param mixed    ...$args
     * @return static
     */
    abstract public function then(callable $callback, ...$args);


    /**
     * Sort all elements of an iterator.
     *
     * @param callable|int $compare       SORT_* flags as binary set or callback comparator function
     * @param bool         $preserveKeys
     * @return static
     */
    public function sort($compare, bool $preserveKeys = true)
    {
        return $this->then(i\iterable_sort, $compare, $preserveKeys);
    }

    /**
     * Sort all elements of an iterator based on the key.
     *
     * @param callable|int $compare   SORT_* flags as binary set or callback comparator function
     * @return static
     */
    public function sortKeys($compare)
    {
        return $this->then(i\iterable_sort_keys, $compare);
    }

    /**
     * Reverse order of elements of an iterable.
     *
     * @return static
     */
    public function reverse()
    {
        return $this->then(i\iterable_reverse);
    }
}