Improved\IteratorPipeline\Traits\FindingTrait

Complexity

Total Complexity

9

Size/Duplication

Total Lines	112
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	find()	0	3	1
A	last()	0	3	1
A	first()	0	3	1
A	hasAny()	0	3	1
A	hasAll()	0	3	1
A	hasNone()	0	3	1
A	min()	0	3	1
A	findKey()	0	3	1
A	max()	0	3	1

<?php

declare(strict_types=1);

namespace Improved\IteratorPipeline\Traits;

use Improved as i;

/**
 * Pipeline methods for finding an element in an iterable.
 */
trait FindingTrait
{
    /**
     * @var iterable
     */
    protected $iterable;

Property Improved\IteratorPipeline\Pipeline::$iterable type has no value type specified in iterable type iterable.

    /**
     * Get the first value of an iterable.
     *
     * @param bool $required  Throw RangeException instead of returning null for empty iterable
     * @return mixed
     */
    public function first(bool $required = false)
    {
        return i\iterable_first($this->iterable, $required);
    }

    /**
     * Get the last value of an iterable.
     *
     * @param bool $required  Throw RangeException instead of returning null for empty iterable
     * @return mixed
     */
    public function last(bool $required = false)
    {
        return i\iterable_last($this->iterable, $required);
    }


    /**
     * Get the first value that matches a condition.
     * Returns null if no element is found.
     *
     * @param callable $matcher
     * @return mixed
     */
    public function find(callable $matcher)
    {
        return i\iterable_find($this->iterable, $matcher);
    }

    /**
     * Get the first value that matches a condition and return the key.
     * Returns null if no element is found.
     *
     * @param callable $matcher
     * @return mixed
     */
    public function findKey(callable $matcher)
    {
        return i\iterable_find_key($this->iterable, $matcher);
    }


    /**
     * Check if any element matches the condition.
     *
     * @param callable $matcher
     * @return bool
     */
    public function hasAny(callable $matcher): bool
    {
        return i\iterable_has_any($this->iterable, $matcher);
    }

    /**
     * Check if all elements match the condition.
     *
     * @param callable $matcher
     * @return bool
     */
    public function hasAll(callable $matcher): bool
    {
        return i\iterable_has_all($this->iterable, $matcher);
    }

    /**
     * Check that no elements match the condition.
     *
     * @param callable $matcher
     * @return bool
     */
    public function hasNone(callable $matcher): bool
    {
        return i\iterable_has_none($this->iterable, $matcher);
    }


    /**
     * Get the minimal value according to a given comparator.
     * Returns null for an empty iterable.
     *
     * @param callable|null $compare
     * @return mixed
     */
    public function min(?callable $compare = null)
    {
        return i\iterable_min($this->iterable, $compare);
    }

    /**
     * Get the maximal value according to a given comparator.
     * Returns null for an empty iterable.
     *
     * @param callable|null $compare
     * @return mixed
     */
    public function max(?callable $compare = null)
    {
        return i\iterable_max($this->iterable, $compare);
    }
}