Translation\Extractor\Visitor\Php\TranslateAnnotationVisitor

Complexity

Total Complexity

11

Size/Duplication

Total Lines	75
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	getTranslateDocParser()	0	13	2
B	enterNode()	0	28	6
A	leaveNode()	0	4	1
A	beforeTraverse()	0	4	1
A	afterTraverse()	0	4	1

<?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 Doctrine\Common\Annotations\DocParser;
use PhpParser\Comment;
use PhpParser\Node;
use PhpParser\NodeVisitor;
use Translation\Extractor\Annotation\Translate;

/**
 * Class TranslationAnnotationVisitor.
 *
 * Supports using @Translate annotation for marking string nodes to be added to the dictionary
 */
class TranslateAnnotationVisitor extends BasePHPVisitor implements NodeVisitor
{
    /** @var DocParser */
    protected $translateDocParser;

    private function getTranslateDocParser(): DocParser
    {
        if (null === $this->translateDocParser) {
            $this->translateDocParser = new DocParser();

            $this->translateDocParser->setImports([
                'translate' => Translate::class,
            ]);
            $this->translateDocParser->setIgnoreNotImportedAnnotations(true);
        }

        return $this->translateDocParser;
    }

    /**
     * {@inheritdoc}
     */
    public function enterNode(Node $node): ?Node
    {
        // look for strings
        if (!$node instanceof Node\Scalar\String_) {
            return null;
        }

        //look for string with comment
        $comments = $node->getAttribute('comments', []);
        if (!\count($comments)) {
            return null;
        }

        foreach ($comments as $comment) {
            if (!$comment instanceof Comment\Doc) {
                return null;
            }

            foreach ($this->getTranslateDocParser()->parse($comment->getText()) as $annotation) {
                //add phrase to dictionary
                $this->addLocation($node->value, $node->getAttribute('startLine'), $node, ['domain' => $annotation->getDomain()]);

                break;
            }
        }

        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function leaveNode(Node $node): ?Node
    {
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function beforeTraverse(array $nodes): ?Node
    {
        return null;
    }

    /**
     * {@inheritdoc}
     */
    public function afterTraverse(array $nodes): ?Node
    {
        return null;
    }
}