php-translation / symfony-bundle

Translator/EditInPlaceTranslator.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\Bundle\Translator;

use Symfony\Component\HttpFoundation\RequestStack;
use Symfony\Component\Translation\MessageCatalogueInterface;
use Symfony\Component\Translation\TranslatorBagInterface;
use Symfony\Component\Translation\TranslatorInterface as LegacyTranslatorInterface;

The type Symfony\Component\Translation\TranslatorInterface was not found. Maybe you did not declare it correctly or list all dependencies?

use Symfony\Contracts\Translation\LocaleAwareInterface;
use Symfony\Contracts\Translation\TranslatorInterface as NewTranslatorInterface;
use Translation\Bundle\EditInPlace\ActivatorInterface;

/**
 * Custom Translator for HTML rendering only (output `<x-trans>` tags).
 *
 * @author Damien Alexandre <dalexandre@jolicode.com>
 */
final class EditInPlaceTranslator implements TranslatorInterface
{
    /**
     * @var LegacyTranslatorInterface|NewTranslatorInterface
     */
    private $translator;

    /**
     * @var ActivatorInterface
     */
    private $activator;

    /**
     * @var RequestStack
     */
    private $requestStack;

    /**
     * $translator param can't be type hinted as we have to deal with both LegacyTranslatorInterface & NewTranslatorInterface.
     * Once we won't support sf ^3.4 anymore, we will be able to type hint $translator with NewTranslatorInterface.
     *
     * @param LegacyTranslatorInterface|NewTranslatorInterface $translator
     */
    public function __construct($translator, ActivatorInterface $activator, RequestStack $requestStack)
    {
        if (!$translator instanceof LegacyTranslatorInterface && !$translator instanceof LocaleAwareInterface) {
            throw new \InvalidArgumentException('The given translator must implements LocaleAwareInterface.');
        }
        if (!$translator instanceof TranslatorBagInterface) {
            throw new \InvalidArgumentException('The given translator must implements TranslatorBagInterface.');
        }

        $this->translator = $translator;
        $this->activator = $activator;
        $this->requestStack = $requestStack;
    }

    /**
     * @see Translator::getCatalogue
     */
    public function getCatalogue($locale = null): MessageCatalogueInterface
    {
        return $this->translator->getCatalogue($locale);

The method getCatalogue() does not exist on Symfony\Contracts\Translation\TranslatorInterface. It seems like you code against a sub-type of Symfony\Contracts\Translation\TranslatorInterface such as Symfony\Component\Translation\Translator or Symfony\Component\Translation\DataCollectorTranslator or Symfony\Component\Translation\LoggingTranslator.

    }

    /**
     * @see Translator::trans
     */
    public function trans($id, array $parameters = [], $domain = null, $locale = null): ?string
    {
        $original = $this->translator->trans($id, $parameters, $domain, $locale);
        if (!$this->activator->checkRequest($this->requestStack->getMasterRequest())) {
            return $original;
        }

        $plain = $this->translator->trans($id, [], $domain, $locale);

        if (null === $domain) {
            $domain = 'messages';
        }
        if (null === $locale) {
            $locale = $this->translator->getLocale();

The method getLocale() does not exist on Symfony\Contracts\Translation\TranslatorInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Translation\PseudoLocalizationTranslator. Are you sure you never get one of those?

        }

        // Render all data in the translation tag required to allow in-line translation
        return \sprintf('<x-trans data-key="%s|%s" data-value="%s" data-plain="%s" data-domain="%s" data-locale="%s">%s</x-trans>',
            $domain,
            $id,
            \htmlspecialchars($original),
            \htmlspecialchars($plain),
            $domain,
            $locale,
            $original
        );
    }

    /**
     * @see Translator::trans
     */
    public function transChoice($id, $number, array $parameters = [], $domain = null, $locale = null): ?string
    {
        if (!$this->activator->checkRequest($this->requestStack->getMasterRequest())) {
            return $this->translator->transChoice($id, $number, $parameters, $domain, $locale);

The method transChoice() does not exist on Symfony\Contracts\Translation\TranslatorInterface. Did you maybe mean trans()?

        }

        $parameters = \array_merge([
            '%count%' => $number,
        ], $parameters);

        return $this->trans($id, $parameters, $domain, $locale);
    }

    /**
     * @see Translator::trans
     */
    public function setLocale($locale): void
    {
        $this->translator->setLocale($locale);

The method setLocale() does not exist on Symfony\Contracts\Translation\TranslatorInterface. It seems like you code against a sub-type of said class. However, the method does not exist in Symfony\Component\Translation\PseudoLocalizationTranslator. Are you sure you never get one of those?

    }

    /**
     * @see Translator::trans
     */
    public function getLocale(): string
    {
        return $this->translator->getLocale();
    }
}