b2pweb / bdf-collections

src/Stream/StreamTrait.php

<?php

namespace Bdf\Collection\Stream;

use Bdf\Collection\HashSet;
use Bdf\Collection\Stream\Accumulator\AccumulatorInterface;
use Bdf\Collection\Stream\Collector\CollectorInterface;
use Bdf\Collection\Util\Optional;
use Bdf\Collection\Util\OptionalInterface;
use function iterator_to_array;

/**
 * Implementation of base stream methods
 *
 * @psalm-suppress LessSpecificImplementedReturnType
 */
trait StreamTrait
{
    /**
     * @see StreamInterface::filter()
     */
    public function filter(callable $predicate): StreamInterface
    {
        return new FilterStream($this, $predicate);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Iterator expected by parameter $iterator of Bdf\Collection\Stream\FilterStream::__construct().

    }

    /**
     * @see StreamInterface::map()
     */
    public function map(callable $transformer): StreamInterface
    {
        return new MapStream($this, $transformer);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Bdf\Collection\Stream\StreamInterface expected by parameter $stream of Bdf\Collection\Stream\MapStream::__construct().

    }

    /**
     * @see StreamInterface::mapKey()
     */
    public function mapKey(callable $function): StreamInterface
    {
        return new MapKeyStream($this, $function);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Bdf\Collection\Stream\StreamInterface expected by parameter $stream of Bdf\Collection\Stream\MapKeyStream::__construct().

    }

    /**
     * @see StreamInterface::distinct()
     */
    public function distinct(callable $hashFunction = null): StreamInterface
    {
        return new DistinctStream($this, new HashSet($hashFunction));

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Bdf\Collection\Stream\StreamInterface expected by parameter $stream of Bdf\Collection\Stream\DistinctStream::__construct().

    }

    /**
     * @see StreamInterface::sort()
     */
    public function sort(callable $comparator = null, bool $preserveKeys = false): StreamInterface
    {
        return new SortStream($this, $comparator, $preserveKeys);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Bdf\Collection\Stream\StreamInterface expected by parameter $stream of Bdf\Collection\Stream\SortStream::__construct().

    }

    /**
     * @see StreamInterface::concat()
     */
    public function concat(StreamInterface $stream, bool $preserveKeys = true): StreamInterface
    {
        return new ConcatStream([$this, $stream], $preserveKeys);
    }

    /**
     * @see StreamInterface::flatMap()
     */
    public function flatMap(callable $transformer, bool $preserveKeys = false): StreamInterface
    {
        return new FlatMapStream($this, $transformer, $preserveKeys);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Bdf\Collection\Stream\StreamInterface expected by parameter $stream of Bdf\Collection\Stream\FlatMapStream::__construct().

    }

    /**
     * @see StreamInterface::skip()
     */
    public function skip(int $count): StreamInterface
    {
        return new LimitStream($this, $count);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Iterator expected by parameter $iterator of Bdf\Collection\Stream\LimitStream::__construct().

    }

    /**
     * @see StreamInterface::limit()
     */
    public function limit(int $count, int $offset = 0): StreamInterface
    {
        return new LimitStream($this, $offset, $count);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Iterator expected by parameter $iterator of Bdf\Collection\Stream\LimitStream::__construct().

    }

    /**
     * @see StreamInterface::forEach()
     */
    public function forEach(callable $consumer): void
    {
        foreach ($this as $key => $value) {
            $consumer($value, $key);
        }
    }

    /**
     * @see StreamInterface::toArray()
     */
    public function toArray(bool $preserveKeys = true): array
    {
        return iterator_to_array($this, $preserveKeys);

$this of type Bdf\Collection\Stream\StreamTrait is incompatible with the type Traversable expected by parameter $iterator of iterator_to_array().

    }

    /**
     * @see StreamInterface::first()
     */
    public function first(): OptionalInterface
    {
        foreach ($this as $value) {
            return Optional::nullable($value);
        }

        return Optional::empty();
    }

    /**
     * @see StreamInterface::reduce()
     * @psalm-suppress MissingParamType
     */
    public function reduce(callable $accumulator, $initial = null)
    {
        $carry = $initial === null && $accumulator instanceof AccumulatorInterface
            ? $accumulator->initial()
            : $initial
        ;

        foreach ($this as $item) {
            $carry = $accumulator($carry, $item);
        }

        return $carry;
    }

    /**
     * @see StreamInterface::collect()
     */
    public function collect(CollectorInterface $collector)
    {
        foreach ($this as $key => $item) {
            $collector->aggregate($item, $key);
        }

        return $collector->finalize();
    }

    /**
     * @see StreamInterface::matchAll()
     */
    public function matchAll(callable $predicate): bool
    {
        foreach ($this as $key => $item) {
            if (!$predicate($item, $key)) {
                return false;
            }
        }

        return true;
    }

    /**
     * @see StreamInterface::matchOne()
     */
    public function matchOne(callable $predicate): bool
    {
        foreach ($this as $key => $item) {
            if ($predicate($item, $key)) {
                return true;
            }
        }

        return false;
    }
}