Stadly\PasswordPolice\WordFormatter\ChainableFormatter

Complexity

Total Complexity

4

Size/Duplication

Total Lines	41
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	getNext()	0	3	1
A	setNext()	0	3	1
A	apply()	0	6	2

<?php

declare(strict_types=1);

namespace Stadly\PasswordPolice\WordFormatter;

use Stadly\PasswordPolice\WordFormatter;
use Traversable;

abstract class ChainableFormatter implements WordFormatter
{
    /**
     * @var WordFormatter|null Next word formatter in the chain.
     */
    private $next;

    /**
     * {@inheritDoc}
     */
    public function setNext(?WordFormatter $next): void
    {
        $this->next = $next;
    }

    /**
     * {@inheritDoc}
     */
    public function getNext(): ?WordFormatter
    {
        return $this->next;
    }

    /**
     * @param iterable<string> $words Words to format.
     * @return Traversable<string> The words formatted by the word formatter chain. May contain duplicates.
     */
    public function apply(iterable $words): Traversable
    {
        if ($this->next === null) {
            yield from $this->applyCurrent($words);
        } else {
            yield from $this->next->apply($this->applyCurrent($words));
        }
    }

    /**
     * @param iterable<string> $words Words to format.
     * @return Traversable<string> The words formatted by this word formatter. May contain duplicates.
     */
    abstract protected function applyCurrent(iterable $words): Traversable;
}