Charcoal\View\Mustache\TranslatorHelpers

Complexity

Total Complexity

18

Size/Duplication

Total Lines	157
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	2
A	setTranslator()	0	4	1
A	toArray()	0	6	1
A	reset()	0	6	1
A	__invoke()	0	19	5
A	__isset()	0	4	1
B	__get()	0	23	7

<?php

declare(strict_types=1);

namespace Charcoal\View\Mustache;

use LogicException;

// From Mustache
use Mustache_LambdaHelper as LambdaHelper;

// From 'charcoal-translator'
use Charcoal\Translator\Translator;

// From 'charcoal-view'
use Charcoal\View\Mustache\HelpersInterface;

/**
 * Translating Mustache Templates
 */
class TranslatorHelpers implements HelpersInterface
{
    /**
     * Store the translator service.
     *
     * @var Translator|null
     */
    private $translator;

    /**
     * Store the given number to use to find the indice of the message (Mustache tag node).
     *
     * This can be a variable name in the context stack or an integer.
     *
     * Floats are not supported due to their decimal symbol conflicting
     * with Mustache's dot-notation.
     *
     * @var string|integer|null
     */
    private $number;

    /**
     * Store the given locale (Mustache tag node).
     *
     * This must be an available locale on the Translator.
     *
     * @var string|null
     */
    private $locale;

    /**
     * Store the given domain for the message (Mustache tag node).
     *
     * This must be an available domain on the Translator.
     *
     * @var string|null
     */
    private $domain;

    /**
     * @param array $data Class Dependencies.
     */
    public function __construct(array $data = null)
    {
        if (isset($data['translator'])) {
            $this->setTranslator($data['translator']);
        }
    }

    /**
     * Set the translator service.
     *
     * @param  Translator $translator The Translator service.
     * @return void
     */
    protected function setTranslator(Translator $translator): void
    {
        $this->translator = $translator;
    }

    /**
     * Retrieve the helpers.
     *
     * @return array
     */
    public function toArray(): array
    {
        return [
            '_t' => $this,
        ];
    }

    /**
     * Clear macros.
     *
     * @return void
     */
    protected function reset(): void
    {
        $this->number = null;
        $this->domain = null;
        $this->locale = null;
    }

    /**
     * Magic: Render the Mustache section.
     *
     * @param  string            $text   The translation key.
     * @param  LambdaHelper|null $helper For rendering strings in the current context.
     * @return string
     */
    public function __invoke(string $text, LambdaHelper $helper = null): string
    {
        if ($this->translator) {
            if ($this->number === null) {
                $text = $this->translator->trans($text, [], $this->domain, $this->locale);
            } else {
                if (!is_numeric($this->number) && is_string($this->number)) {
                    $this->number = $helper->render('{{ '.$this->number.' }}');

It seems like $helper is not always an object, but can also be of type null. Maybe add an additional type check?

                }

                $text = $this->translator->transChoice($text, (int)$this->number, [], $this->domain, $this->locale);
            }

            $this->reset();
        }

        /** @var string Render any Mustache tags in the translation. */
        return $helper->render($text);
    }

    /**
     * Magic: Determine if a property is set and is not NULL.
     *
     * Required by Mustache.
     *
     * @param  string $macro A domain, locale, or number.
     * @return boolean
     */
    public function __isset(string $macro): bool
    {
        return boolval($macro);
    }

    /**
     * Magic: Process domain, locale, and number.
     *
     * Required by Mustache.
     *
     * @param  string $macro A domain, locale, or number.
     * @throws LogicException If the macro is unresolved.
     * @return mixed
     */
    public function __get(string $macro)
    {
        if (!$this->translator) {
            return $this;
        }

        if ($this->locale === null && in_array($macro, $this->translator->availableLocales())) {
            $this->locale = $macro;
            return $this;
        }

        if ($this->domain === null && in_array($macro, $this->translator->availableDomains())) {
            $this->domain = $macro;
            return $this;
        }

        if ($this->number === null) {
            $this->number = $macro;
            return $this;
        }

        throw new LogicException(sprintf('Unknown translator macro: %s', $macro));
    }
}