php-translation / extractor

src/Visitor/Php/SourceLocationContainerVisitor.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\Visitor\Php;

use PhpParser\Node;
use PhpParser\NodeVisitor;
use Translation\Extractor\Model\SourceLocation;

/**
 * Extract translations from classes implementing
 * Translation\Extractor\Model\SourceLocation\TranslationSourceLocationContainer.
 *
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
final class SourceLocationContainerVisitor extends BasePHPVisitor implements NodeVisitor
{
    /**
     * @var string
     */
    private $namespace = '';

    /**
     * @var array
     */
    private $useStatements = [];

    public function beforeTraverse(array $nodes)
    {
    }

    public function enterNode(Node $node)
    {
        if ($node instanceof Node\Stmt\Namespace_) {

This code seems to be duplicated across your project.

            if (isset($node->name)) {
                // Save namespace of this class for later.
                $this->namespace = implode('\\', $node->name->parts);
            }
            $this->useStatements = [];

            return;
        }

        if ($node instanceof Node\Stmt\UseUse) {
            $key = isset($node->alias) ? $node->alias : $node->name->parts[count($node->name->parts) - 1];
            $this->useStatements[(string) $key] = implode('\\', $node->name->parts);

            return;
        }

        if (!$node instanceof Node\Stmt\Class_) {
            return;
        }

        $isContainer = false;
        foreach ($node->implements as $interface) {
            $name = implode('\\', $interface->parts);
            if (isset($this->useStatements[$name])) {
                $name = $this->useStatements[$name];
            }

            if ('Translation\Extractor\TranslationSourceLocationContainer' === $name) {
                $isContainer = true;

                break;
            }
        }

        if (!$isContainer) {
            return;
        }

        $sourceLocations = call_user_func([$this->namespace.'\\'.$node->name, 'getTranslationSourceLocations']);
        if (!is_array($sourceLocations)) {
            throw new \RuntimeException(sprintf('%s::getTranslationSourceLocations() was expected to return an array of SourceLocations, but got %s.', $this->namespace.'\\'.$node->name, gettype($sourceLocations)));
        }

        foreach ($sourceLocations as $sourceLocation) {
            if (!$sourceLocation instanceof SourceLocation) {
                throw new \RuntimeException(sprintf('%s::getTranslationSourceLocations() was expected to return an array of SourceLocations, but got an array which contains an item of type %s.', $this->namespace.'\\'.$node->name, gettype($sourceLocation)));
            }

            $this->collection->addLocation($sourceLocation);
        }
    }

    public function leaveNode(Node $node)
    {
    }

    public function afterTraverse(array $nodes)
    {
    }
}