Stratadox / ImmutableCollection

src/Filtering.php

<?php

declare(strict_types=1);

namespace Stratadox\ImmutableCollection;

use function array_filter;
use Closure;
use Stratadox\Collection\Collection;
use Stratadox\Collection\Filterable;
use Stratadox\Specification\Contract\Satisfiable;

/**
 * Behaviour to allow "filtering" the immutable collection.
 *
 * Provides access to filtering behaviour in the form of a method that
 * returns a modified copy of the original (immutable) collection.
 *
 * @package Stratadox\Collection
 * @author  Stratadox
 */
trait Filtering
{
    /**
     * @see Filterable::that
     * @param Satisfiable $condition
     * @return static
     */
    public function that(Satisfiable $condition)
    {
        return $this->newCopy(array_filter(

The expression return $this->newCopy(array_filter($this->items(), array($condition, 'isSatisfiedBy'))) returns the type Stratadox\Collection\Collection which is incompatible with the documented return type Stratadox\ImmutableCollection\Filtering.

            $this->items(), [$condition, 'isSatisfiedBy']
        ));
    }

    /**
     * @see Filterable::filterWith
     * @param Closure $function
     * @return static
     */
    public function filterWith(Closure $function)
    {
        return $this->newCopy(array_filter(

The expression return $this->newCopy(array_filter($this->items(), $function)) returns the type Stratadox\Collection\Collection which is incompatible with the documented return type Stratadox\ImmutableCollection\Filtering.

            $this->items(), $function
        ));
    }

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

    /**
     * @see ImmutableCollection::newCopy()
     * @param array $items
     * @return static
     */
    abstract protected function newCopy(array $items): Collection;
}