php-translation / extractor

src/FileExtractor/PHPFileExtractor.php

<?php

/*
 * This file is part of the PHP Translation package.
 *
 * (c) PHP Translation team <tobias.nyholm@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Translation\Extractor\FileExtractor;

use PhpParser\Error;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor;
use PhpParser\ParserFactory;
use Symfony\Component\Finder\SplFileInfo;
use Translation\Extractor\Model\SourceCollection;
use Translation\Extractor\Visitor\Visitor;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
final class PHPFileExtractor implements FileExtractor
{
    /**
     * @var Visitor[]|NodeVisitor[]
     */
    private $visitors = [];

    /**
     * {@inheritdoc}
     */
    public function getSourceLocations(SplFileInfo $file, SourceCollection $collection): void
    {
        $path = $file->getRelativePath();
        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
        $traverser = new NodeTraverser();
        foreach ($this->visitors as $v) {
            $v->init($collection, $file);

The method init does only exist in Translation\Extractor\Visitor\Visitor, but not in PhpParser\NodeVisitor.

            $traverser->addVisitor($v);

It seems like $v defined by $v on line 40 can also be of type object<Translation\Extractor\Visitor\Visitor>; however, PhpParser\NodeTraverser::addVisitor() does only seem to accept object<PhpParser\NodeVisitor>, maybe add an additional type check?

        }

        try {
            $tokens = $parser->parse($file->getContents());
            $traverser->traverse($tokens);
        } catch (Error $e) {
            trigger_error(sprintf('Skipping file "%s" because of parse Error: %s. ', $path, $e->getMessage()));
        }
    }

    /**
     * {@inheritdoc}
     */
    public function getType(): string
    {
        return 'php';
    }

    public function addVisitor(NodeVisitor $visitor): void
    {
        $this->visitors[] = $visitor;
    }
}