jasny / improved-php-iterable

src/IteratorPipeline/Pipeline.php

<?php

declare(strict_types=1);

namespace Improved\IteratorPipeline;

use Improved as i;

/**
 * Functional-style operations, such as map-reduce transformations on arrays and iterators.
 * A pipeline uses Generators, meaning it can be used only once.
 */
class Pipeline implements \IteratorAggregate

Class Improved\IteratorPipeline\Pipeline implements generic interface IteratorAggregate but does not specify its types: TKey, TValue

{
    use Traits\MappingTrait;
    use Traits\FilteringTrait;
    use Traits\SortingTrait;
    use Traits\TypeHandlingTrait;
    use Traits\FindingTrait;
    use Traits\AggregationTrait;

    /**
     * @var iterable
     */
    protected $iterable;

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

    /**
     * Pipeline constructor.
     *
     * @param iterable $iterable
     */
    public function __construct(iterable $iterable)

Method Improved\IteratorPipeline\Pipeline::__construct() has parameter $iterable with no value type specified in iterable type iterable.

    {
        $this->iterable = $iterable;
    }

    /**
     * Define the next step via a callback that returns an array or Traversable object.
     *
     * @param callable $callback
     * @param mixed    ...$args
     * @return self
     */
    public function then(callable $callback, ...$args): self

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

    {
        $this->iterable = i\type_check(
            $callback($this->iterable, ...$args),
            'iterable',
            new \UnexpectedValueException("Expected step to return an array or Traversable, %s returned")
        );

        return $this->iterable instanceof Pipeline ? $this->iterable : $this;
    }


    /**
     * Get iterator.
     *
     * @return \Iterator
     */
    public function getIterator(): \Iterator

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

    {
        return i\iterable_to_iterator($this->iterable);
    }

    /**
     * Get iterable as array.
     *
     * @return array
     */
    public function toArray(): array

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

    {
        return i\iterable_to_array($this->iterable, true);
    }

    /**
     * Traverse over the iterator, not capturing the values.
     * This is particularly useful after `apply()`.
     *
     * @return void
     */
    public function walk(): void
    {
        i\iterable_walk($this->iterable);
    }


    /**
     * Factory method
     *
     * @param iterable $iterable
     * @return static
     */
    final public static function with(iterable $iterable): self

Method Improved\IteratorPipeline\Pipeline::with() has parameter $iterable with no value type specified in iterable type iterable.

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

    {
        return $iterable instanceof static ? $iterable : new static($iterable);

Unsafe usage of new static().

    }

    /**
     * Factory method for PipelineBuilder
     *
     * @return PipelineBuilder
     */
    public static function build(): PipelineBuilder
    {
        return new PipelineBuilder();
    }
}