Stratadox\ImmutableCollection\Altering

Complexity

Total Complexity

1

Size/Duplication

Total Lines	24
Duplicated Lines	0 %

Importance

Changes

0

1 Method

Rating	Name	Duplication	Size	Complexity
A	change()	0	5	1

<?php

declare(strict_types=1);

namespace Stratadox\ImmutableCollection;

use Stratadox\Collection\Alterable;
use Stratadox\Collection\Collection;

/**
 * Behaviour to allow "altering" the immutable collection.
 *
 * Provides access to update and delete behaviour in the form of methods that
 * return a modified copy of the original (immutable) collection.
 *
 * @package Stratadox\Collection
 * @author  Stratadox
 */
trait Altering
{
    /**
     * @see Alterable::change()
     * @param int   $index
     * @param mixed $newItem
     * @return static
     */
    public function change(int $index, $newItem)
    {
        $items = $this->items();
        $items[$index] = $newItem;
        return $this->newCopy($items);

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

    }

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

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