tigitz / php-spellchecker

src/Utils/IspellOutputParser.php

<?php

declare(strict_types=1);

namespace PhpSpellcheck\Utils;

use PhpSpellcheck\Misspelling;

class IspellOutputParser
{
    /**
     * @return Misspelling[]
     */
    public static function parseMisspellings(string $output, array $context): iterable
    {
        $lines = explode(PHP_EOL, $output);
        $lineNumber = 1;
        foreach ($lines as $line) {
            $line = trim($line);
            if ('' === $line) {
                $lineNumber++;
                // Go to the next line
                continue;
            }

            switch ($line[0]) {
                case '#':
                    list(, $word, $offset) = explode(' ', $line);
                    yield new Misspelling(

The expression yield new PhpSpellcheck\Misspelling($word, (int)trim($offset), $lineNumber, array(), $context) returns the type Generator which is incompatible with the documented return type PhpSpellcheck\Misspelling[].

                        $word,
                        (int) trim($offset),
                        $lineNumber,
                        [],
                        $context
                    );
                    break;
                case '&':
                    $parts = explode(':', $line);
                    list(, $word, , $offset) = explode(' ', $parts[0]);
                    yield new Misspelling(
                        $word,
                        (int) trim($offset),
                        $lineNumber,
                        explode(', ', trim($parts[1])),
                        $context
                    );
                    break;
            }
        }
    }
}