Improved\IteratorPipeline\Traits\MappingTrait

Complexity

Total Complexity

15

Size/Duplication

Total Lines	184
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	mapKeys()	0	3	1
A	map()	0	3	1
A	apply()	0	3	1
A	chunk()	0	3	1
A	group()	0	3	1
A	flatten()	0	3	1
A	project()	0	3	1
A	keys()	0	3	1
A	fill()	0	3	1
A	column()	0	3	1
A	flip()	0	3	1
A	values()	0	3	1
A	unwind()	0	3	1
A	reshape()	0	3	1
A	setKeys()	0	7	1

<?php

declare(strict_types=1);

namespace Improved\IteratorPipeline\Traits;

use Improved as i;
use Improved\Iterator\CombineIterator;

/**
 * Mapping and projection methods for iterator pipeline
 */
trait MappingTrait
{
    /**
     * 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);


    /**
     * Map each element to a value using a callback function.
     *
     * @param callable $callback
     * @return static
     */
    public function map(callable $callback)

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

    {
        return $this->then("Improved\iterable_map", $callback);

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

    }

    /**
     * Map the key of each element to a new key using a callback function.
     *
     * @param callable $callback
     * @return static
     */
    public function mapKeys(callable $callback)

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

    {
        return $this->then("Improved\iterable_map_keys", $callback);

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

    }

    /**
     * Apply a callback to each element of an iterator.
     * Any value returned by the callback is ignored.
     *
     * @param callable $callback
     * @return static
     */
    public function apply(callable $callback)

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

    {
        return $this->then("Improved\iterable_apply", $callback);

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

    }

    /**
     * Divide iterable into chunks of specified size.
     *
     * @param int $size
     * @return static
     */
    public function chunk(int $size)

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

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

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

    }

    /**
     * Group elements of an iterator, with the group name as key and an array of elements as value.
     *
     * @param callable $grouping
     * @return static
     */
    public function group(callable $grouping)

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

    {
        return $this->then("Improved\iterable_group", $grouping);

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

    }

    /**
     * Walk through all sub-iterables and concatenate them.
     *
     * @param bool $preserveKeys
     * @return static
     */
    public function flatten(bool $preserveKeys = false)

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

    {
        return $this->then("Improved\iterable_flatten", $preserveKeys);

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

    }

    /**
     * Deconstruct an iterable property/item for each element. The result is one element for each item in the iterable
     * property.
     *
     * @param string      $column
     * @param string|null $mapKey        The name of a new property to hold the array index of the element
     * @param bool        $preserveKeys  Preserve the keys of the iterable (will result in duplicate keys)
     * @return static
     */
    public function unwind(string $column, ?string $mapKey = null, bool $preserveKeys = false)

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

    {
        return $this->then("Improved\iterable_unwind", $column, $mapKey, $preserveKeys);

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

    }

    /**
     * Set all values of the iterable.
     *
     * @param mixed $value
     * @return static
     */
    public function fill($value)

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

    {
        return $this->then("Improved\iterable_fill", $value);

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

    }

    /**
     * Return the values from a single column / property.
     * Create key/value pairs by specifying the key.
     *
     * @param string|int|null $valueColumn  null to keep values
     * @param string|int|null $keyColumn    null to keep keys
     * @return static
     */
    public function column($valueColumn, $keyColumn = null)

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

    {
        return $this->then("Improved\iterable_column", $valueColumn, $keyColumn);

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

    }

    /**
     * Project each element of an iterator to an associated (or numeric) array.
     * Each element should be an array or object.
     *
     * @param array $mapping  [new key => old key, ...]
     * @return static
     */
    public function project(array $mapping)

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

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

Method Improved\IteratorPipeline\PipelineBuilder::project() has parameter $mapping with no value type specified in iterable type array.

    {
        return $this->then("Improved\iterable_project", $mapping);

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

    }

    /**
     * Reshape each element of an iterator, adding or removing properties or keys.
     *
     * @param array $columns  [key => bool|string|int, ...]
     * @return static
     */
    public function reshape(array $columns)

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

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

Method Improved\IteratorPipeline\PipelineBuilder::reshape() has parameter $columns with no value type specified in iterable type array.

    {
        return $this->then("Improved\iterable_reshape", $columns);

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

    }


    /**
     * Keep the values, drop the keys. The keys become an incremental number.
     *
     * @return static
     */
    public function values()

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

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

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

    }

    /**
     * Use the keys as values. The keys become an incremental number.
     *
     * @return static
     */
    public function keys()

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

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

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

    }

    /**
     * Use another iterator as keys and the current iterator as values.
     *
     * @param iterable $keys
     * @return static
     */
    public function setKeys(iterable $keys)

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

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

    {
        $combine = function ($values, $keys) {

Anonymous function should have native return typehint "Improved\Iterator\CombineIterator".

            return new CombineIterator($keys, $values);
        };

        return $this->then($combine, $keys);

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

    }

    /**
     * Use values as keys and visa versa.
     *
     * @return static
     */
    public function flip()

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

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

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

    }
}