php-translation / extractor

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

use PhpParser\Node;
use PhpParser\NodeVisitor;
use Translation\Extractor\Model\SourceLocation;
use Translation\Extractor\Visitor\Php\BasePHPVisitor;

/**
 * @author Tobias Nyholm <tobias.nyholm@gmail.com>
 */
abstract class AbstractFormType extends BasePHPVisitor implements NodeVisitor
{
    /**
     * @var SourceLocation[]
     */
    private $sourceLocations = [];

    /**
     * @var string|null
     */
    private $defaultDomain;

    /**
     * {@inheritdoc}
     */
    public function enterNode(Node $node): ?Node
    {
        if ($node instanceof Node\Expr\MethodCall) {
            if (!\is_string($node->name) && !$node->name instanceof Node\Identifier) {
                return null;
            }

            $name = strtolower((string) $node->name);
            if ('setdefaults' === $name || 'replacedefaults' === $name || 'setdefault' === $name) {
                $this->parseDefaultsCall($node);

                return null;
            }
        }

        return null;
    }

    protected function lateCollect(SourceLocation $location): void
    {
        $this->sourceLocations[] = $location;
    }

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

    /**
     * {@inheritdoc}
     */
    public function beforeTraverse(array $nodes): ?Node
    {
        $this->defaultDomain = null;
        $this->sourceLocations = [];

        return null;
    }

    /**
     * From JMS Translation bundle.
     */
    private function parseDefaultsCall(Node $node): void
    {
        static $returningMethods = [
            'setdefaults' => true, 'replacedefaults' => true, 'setoptional' => true, 'setrequired' => true,
            'setallowedvalues' => true, 'addallowedvalues' => true, 'setallowedtypes' => true,
            'addallowedtypes' => true, 'setfilters' => true,
        ];

        $var = $node->var;

Accessing var on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

        while ($var instanceof Node\Expr\MethodCall) {
            if (!isset($returningMethods[strtolower($var->name)])) {
                return;
            }

            $var = $var->var;
        }

        if (!$var instanceof Node\Expr\Variable) {
            return;
        }

        // check if options were passed
        if (!isset($node->args[0])) {

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            return;
        }

        if (isset($node->args[1])

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            && $node->args[0]->value instanceof Node\Scalar\String_

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            && $node->args[1]->value instanceof Node\Scalar\String_

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            && 'translation_domain' === $node->args[0]->value->value

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

        ) {
            $this->defaultDomain = $node->args[1]->value->value;

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            return;
        }

        // ignore everything except an array
        if (!$node->args[0]->value instanceof Node\Expr\Array_) {

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            return;
        }

        // check if a translation_domain is set as a default option
        $domain = null;

$domain is not used, you could remove the assignment.

        foreach ($node->args[0]->value->items as $item) {

Accessing args on the interface PhpParser\Node suggest that you code against a concrete implementation. How about adding an instanceof check?

            if (!$item->key instanceof Node\Scalar\String_) {
                continue;
            }

            if ('translation_domain' === $item->key->value) {
                if (!$item->value instanceof Node\Scalar\String_) {
                    continue;
                }

                $this->defaultDomain = $item->value->value;
            }
        }
    }

    /**
     * {@inheritdoc}
     */
    public function afterTraverse(array $nodes): ?Node
    {
        /** @var SourceLocation $location */
        foreach ($this->sourceLocations as $location) {
            if (null !== $this->defaultDomain) {
                $context = $location->getContext();
                if (null === $context['domain']) {
                    $context['domain'] = $this->defaultDomain;
                    $location = new SourceLocation($location->getMessage(), $location->getPath(), $location->getLine(), $context);
                }
            }
            $this->collection->addLocation($location);
        }
        $this->sourceLocations = [];

        return null;
    }
}