Improved\IteratorPipeline\Traits\FilteringTrait

Complexity

Total Complexity

8

Size/Duplication

Total Lines	102
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	filter()	0	3	1
A	limit()	0	3	1
A	slice()	0	3	1
A	cleanup()	0	3	1
A	unique()	0	3	1
A	after()	0	3	1
A	before()	0	3	1
A	uniqueKeys()	0	4	1

<?php

declare(strict_types=1);

namespace Improved\IteratorPipeline\Traits;

/**
 * Filtering methods for iterator pipeline.
 */
trait FilteringTrait
{
    /**
     * 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);


    /**
     * Eliminate elements based on a criteria.
     *
     * @param callable $matcher
     * @return static
     */
    public function filter(callable $matcher)

Method Improved\IteratorPipeline\Pipeline::filter() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_filter", $matcher);

Method Improved\IteratorPipeline\Pipeline::filter() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Filter out `null` values from iteratable.
     *
     * @return static
     */
    public function cleanup()

Method Improved\IteratorPipeline\Pipeline::cleanup() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_cleanup");

Method Improved\IteratorPipeline\Pipeline::cleanup() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Filter on unique elements.
     *
     * @param callable|null $grouper  If provided, filtering will be based on return value.
     * @return static
     */
    public function unique(?callable $grouper = null)

Method Improved\IteratorPipeline\Pipeline::unique() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_unique", $grouper);

Method Improved\IteratorPipeline\Pipeline::unique() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Filter our duplicate keys.
     * Unlike associative arrays, the keys of iterators don't have to be unique.
     *
     * @return static
     */
    public function uniqueKeys()

Method Improved\IteratorPipeline\Pipeline::uniqueKeys() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_unique", function ($value, $key) {

Method Improved\IteratorPipeline\Pipeline::uniqueKeys() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

            return $key;
        });
    }

    /**
     * Get only the first elements of an iterator.
     *
     * @param int $size
     * @return static
     */
    public function limit(int $size)

Method Improved\IteratorPipeline\Pipeline::limit() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_slice", 0, $size);

Method Improved\IteratorPipeline\Pipeline::limit() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Get a limited subset of the elements using an offset.
     *
     * @param int      $offset
     * @param int|null $size    size limit
     * @return static
     */
    public function slice(int $offset, ?int $size = null)

Method Improved\IteratorPipeline\Pipeline::slice() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_slice", $offset, $size);

Method Improved\IteratorPipeline\Pipeline::slice() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Get elements until a match is found.
     *
     * @param callable $matcher
     * @param bool     $include
     * @return static
     */
    public function before(callable $matcher, bool $include = false)

Method Improved\IteratorPipeline\Pipeline::before() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_before", $matcher, $include);

Method Improved\IteratorPipeline\Pipeline::before() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }

    /**
     * Get elements after a match is found.
     *
     * @param callable $matcher
     * @param bool     $include
     * @return static
     */
    public function after(callable $matcher, bool $include = false)

Method Improved\IteratorPipeline\Pipeline::after() return type has no value type specified in iterable type static(Improved\IteratorPipeline\Pipeline).

    {
        return $this->then("Improved\iterable_after", $matcher, $include);

Method Improved\IteratorPipeline\Pipeline::after() should return static(Improved\IteratorPipeline\Pipeline) but returns Improved\IteratorPipeline\Pipeline.

    }
}