Stratadox\ImmutableCollection\Reducing

Complexity

Total Complexity

1

Size/Duplication

Total Lines	15
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	reduce()	0	3	1

<?php

declare(strict_types=1);

namespace Stratadox\ImmutableCollection;

use function array_reduce;
use Closure;

/**
 * Behaviour to allow "reducing" the immutable collection.
 *
 * Provides access to reduction behaviour in the form of a method that
 * returns a reduced value based on the original collection.
 *
 * @package Stratadox\Collection
 * @author  Stratadox
 */
trait Reducing
{
    /**
     * @see Reducible::reduce()
     * @param Closure $function
     * @param mixed   $initial
     * @return mixed
     */
    public function reduce(Closure $function, $initial = null)
    {
        return array_reduce($this->items(), $function, $initial);
    }

    /** @see Collection::items() */
    abstract public function items(): array;
}