Charcoal\Translator\Translator

Complexity

Total Complexity

39

Size/Duplication

Total Lines	266
Duplicated Lines	24.06 %

Coupling/Cohesion

Components	2
Dependencies	3

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	24	2
A	addResource()	0	8	2
A	availableDomains()	0	4	1
B	translation()	15	15	5
B	translate()	17	17	5
B	translationChoice()	15	15	5
B	translateChoice()	17	17	5
A	locales()	0	4	1
A	availableLocales()	0	4	1
A	setLocale()	0	6	1
A	setManager()	0	4	1
D	isValidTranslation()	0	31	10

<?php

namespace Charcoal\Translator;

// From 'symfony/translation'
use Symfony\Component\Translation\Translator as SymfonyTranslator;

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

/**
 * Charcoal Translator.
 *
 * Extends the Symfony translator to allow returned values in a "Translation" oject,
 * containing localizations for all locales.
 */
class Translator extends SymfonyTranslator
{
    /**
     * The locales manager.
     *
     * @var LocalesManager
     */
    private $manager;

    /**
     * The loaded domains.
     *
     * @var string[]
     */
    private $domains = [ 'messages' ];

    /**
     * @param array $data Constructor data.
     */
    public function __construct(array $data)
    {
        $this->setManager($data['manager']);

        $defaults = [
            'locale'            => $this->manager->currentLocale(),
            'message_selector'  => null,
            'cache_dir'         => null,
            'debug'             => false
        ];
        $data = array_merge($defaults, $data);

        // If symfony-config is not installed, DON'T use cache.
        if (!class_exists('\Symfony\Component\Config\ConfigCacheFactory')) {
            $data['cache_dir'] = null;
        }

        parent::__construct(
            $data['locale'],
            $data['message_selector'],
            $data['cache_dir'],
            $data['debug']
        );
    }

    /**
     * Adds a resource.
     *
     * @see    SymfonyTranslator::addResource() Keep track of the translation domains.
     * @param  string      $format   The name of the loader (@see addLoader()).
     * @param  mixed       $resource The resource name.
     * @param  string      $locale   The locale.
     * @param  string|null $domain   The domain.
     * @return void
     */
    public function addResource($format, $resource, $locale, $domain = null)
    {
        if (null !== $domain) {
            $this->domains[] = $domain;
        }

        parent::addResource($format, $resource, $locale, $domain);
    }

    /**
     * Retrieve the loaded domains.
     *
     * @return string[]
     */
    public function availableDomains()
    {
        return $this->domains;
    }

    /**
     * Retrieve a translation object from a (mixed) message.
     *
     * @uses   SymfonyTranslator::trans()
     * @param  mixed       $val        The string or translation-object to retrieve.
     * @param  array       $parameters An array of parameters for the message.
     * @param  string|null $domain     The domain for the message or NULL to use the default.
     * @return Translation|null The translation object or NULL if the value is not translatable.
     */
    public function translation($val, array $parameters = [], $domain = null)

This method seems to be duplicated in your project.

    {
        if ($this->isValidTranslation($val) === false) {
            return null;
        }

        $translation = new Translation($val, $this->manager);
        foreach ($this->availableLocales() as $lang) {
            if (!isset($translation[$lang]) || $translation[$lang] == $val) {
                $translation[$lang] = $this->trans((string)$translation, $parameters, $domain, $lang);
            }
        }

        return $translation;
    }

    /**
     * Translates the given (mixed) message.
     *
     * @uses   SymfonyTranslator::trans()
     * @uses   Translator::translation()
     * @param  mixed       $val        The string or translation-object to retrieve.
     * @param  array       $parameters An array of parameters for the message.
     * @param  string|null $domain     The domain for the message or NULL to use the default.
     * @param  string|null $locale     The locale or NULL to use the default.
     * @return string The translated string
     */
    public function translate($val, array $parameters = [], $domain = null, $locale = null)

This method seems to be duplicated in your project.

    {
        if ($val instanceof Translation) {
            return strtr($val[$locale], $parameters);
        }

        if (is_object($val) && method_exists($val, '__toString')) {
            $val = (string)$val;
        }

        if (is_string($val)) {
            return $this->trans($val, $parameters, $domain, $locale);
        } else {
            $translation = $this->translation($val, $parameters, $domain);
            return $translation[$locale];
        }
    }

    /**
     * Retrieve a translation object from a (mixed) message by choosing a translation according to a number.
     *
     * @uses   SymfonyTranslator::transChoice()
     * @param  mixed       $val        The string or translation-object to retrieve.
     * @param  integer     $number     The number to use to find the indice of the message.
     * @param  array       $parameters An array of parameters for the message.
     * @param  string|null $domain     The domain for the message or NULL to use the default.
     * @return Translation|null The translation object or NULL if the value is not translatable.
     */
    public function translationChoice($val, $number, array $parameters = [], $domain = null)

This method seems to be duplicated in your project.

    {
        if ($this->isValidTranslation($val) === false) {
            return null;
        }

        $translation = new Translation($val, $this->manager);
        foreach ($this->availableLocales() as $lang) {
            if (!isset($translation[$lang]) || $translation[$lang] == $val) {
                $translation[$lang] = $this->transChoice((string)$translation, $number, $parameters, $domain, $lang);
            }
        }

        return $translation;
    }

    /**
     * Translates the given (mixed) choice message by choosing a translation according to a number.
     *
     * @uses   SymfonyTranslator::transChoice()
     * @uses   Translator::translationChoice()
     * @param  mixed       $val        The string or translation-object to retrieve.
     * @param  integer     $number     The number to use to find the indice of the message.
     * @param  array       $parameters An array of parameters for the message.
     * @param  string|null $domain     The domain for the message or NULL to use the default.
     * @param  string|null $locale     The locale or NULL to use the default.
     * @return string The translated string
     */
    public function translateChoice($val, $number, array $parameters = [], $domain = null, $locale = null)

This method seems to be duplicated in your project.

    {
        if ($val instanceof Translation) {
            return strtr($val[$locale], $parameters);
        }

        if (is_object($val) && method_exists($val, '__toString')) {
            $val = (string)$val;
        }

        if (is_string($val)) {
            return $this->transChoice($val, $number, $parameters, $domain, $locale);
        } else {
            $translation = $this->translationChoice($val, $number, $parameters, $domain);
            return $translation[$locale];
        }
    }

    /**
     * Retrieve the available locales information.
     *
     * @return array
     */
    public function locales()
    {
        return $this->manager->locales();
    }

    /**
     * Retrieve the available locales (language codes).
     *
     * @return string[]
     */
    public function availableLocales()
    {
        return $this->manager->availableLocales();
    }

    /**
     * Sets the current locale.
     *
     * @see    SymfonyTranslator::setLocale() Ensure that the method also changes the locales manager's language.
     * @param  string $locale The locale.
     * @return void
     */
    public function setLocale($locale)
    {
        parent::setLocale($locale);

        $this->manager->setCurrentLocale($locale);
    }

    /**
     * Set the locales manager.
     *
     * @param  LocalesManager $manager The locales manager.
     * @return void
     */
    private function setManager(LocalesManager $manager)
    {
        $this->manager = $manager;
    }

    /**
     * Determine if the value is translatable.
     *
     * @param  mixed $val The value to be checked.
     * @return boolean
     */
    private function isValidTranslation($val)
    {
        if (empty($val) && !is_numeric($val)) {
            return false;
        }

        if (is_string($val)) {
            return !empty(trim($val));
        }

        if ($val instanceof Translation) {
            return true;
        }

        if (is_array($val)) {
            return !!array_filter(
                $val,
                function ($v, $k) {
                    if (is_string($k) && strlen($k) > 0) {
                        if (is_string($v) && strlen($v) > 0) {
                            return true;
                        }
                    }

                    return false;
                },
                ARRAY_FILTER_USE_BOTH
            );
        }
        return false;
    }
}