Slick\I18n\Translator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	209
Duplicated Lines	0 %

Coupling/Cohesion

Components	3
Dependencies	4

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	__clone()	0	3	1
A	__wakeup()	0	3	1
A	getConfiguration()	0	7	2
A	getTranslatorService()	0	14	2
A	getMessageFile()	0	6	1
A	translate()	0	5	1
A	translatePlural()	0	11	1
A	getInstance()	0	7	2
A	setLocale()	0	5	1
A	getLocale()	0	5	1

<?php

/**
 * This file is part of slick/i18n package
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Slick\I18n;

use Slick\Common\BaseMethods;
use Slick\Configuration\Configuration;
use Slick\Configuration\ConfigurationInterface as DriverInterface;
use Zend\I18n\Translator\Translator as ZendTranslator;

/**
 * Translator (I18n)
 *
 * @package Slick\I18n
 * @author  Filipe Silva <silvam.filipe@gmail.com>
 *
 * @property DriverInterface $configuration
 * @property ZendTranslator  $translatorService
 *
 * @property string $type
 * @property string $basePath
 * @property string $domain
 * @property string $fallbackLocale
 */
class Translator
{
    /**
     * @readwrite
     * @var ZendTranslator
     */
    protected $_translatorService;

    /**
     * @readwrite
     * @var DriverInterface
     */
    protected $_configuration;

    /**
     * @readwrite
     * @var string The message domain
     */
    protected $_domain = 'default';

    /**
     * @readwrite
     * @var string Default fallback locale
     */
    protected $_fallbackLocale = 'en_US';

    /**
     * @readwrite
     * @var string
     */
    protected $_basePath = './I18n';

    /**
     * @readwrite
     * @var string
     */
    protected $_type = 'gettext';

    /**
     * @var array
     */
    private $_types = [
        'gettext' => '.mo',
        'phparray' => '.php'
    ];

    /**
     * @var Translator
     */
    private static $_instance;

    /**
     * Trait with method for base class
     */
    use BaseMethods;

    /**
     * Protected constructor to prevent creating a new instance of the
     * *Singleton* via the `new` operator from outside of this class.
     *
     * @param array $options A list of properties for this connector
     */
    protected function __construct($options = array())
    {
        $this->hydrate($options);
    }

    /**
     * Private clone method to prevent cloning of the instance of the
     * *Singleton* instance.
     *
     * @codeCoverageIgnore
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     * @return void
     */
    private function __clone()
    {
    }

    /**
     * Private unserialize method to prevent unserializing of the *Singleton*
     * instance.
     *
     * @codeCoverageIgnore
     * @SuppressWarnings(PHPMD.UnusedPrivateMethod)
     * @return void
     */
    private function __wakeup()
    {
    }

    /**
     * Lazy loads configuration
     *
     * @return DriverInterface
     */
    public function getConfiguration()
    {
        if (is_null($this->_configuration)) {
            $this->_configuration = Configuration::get('config');
        }
        return $this->_configuration;
    }

    /**
     * Lazy loads zend translator
     *
     * @return ZendTranslator
     */
    public function getTranslatorService()
    {
        if (is_null($this->_translatorService)) {
            $translator = new ZendTranslator();
            $translator->addTranslationFilePattern(
                $this->type,
                $this->basePath,
                '%s/'.$this->getMessageFile(),
                $this->domain
            );
            $this->_translatorService = $translator;
        }
        return $this->_translatorService;
    }

    /**
     * Returns the messages file name based on domain
     *
     * @return string
     */
    public function getMessageFile()
    {
        $name = $this->domain;
        $name .= $this->_types[$this->type];
        return $name;
    }

    /**
     * Returns the translation for the provided message
     *
     * @param string $message
     *
     * @return string
     */
    public function translate($message)
    {
        return $this->getTranslatorService()
            ->translate($message, $this->domain, $this->getLocale());
    }

    /**
     * Translate a plural message.
     *
     * @param  string $singular
     * @param  string $plural
     * @param  int    $number
     *
     * @return string
     */
    public function translatePlural($singular, $plural, $number)
    {
        return $this->getTranslatorService()
            ->translatePlural(
                $singular,
                $plural,
                $number,
                $this->domain,
                $this->getLocale()
            );
    }

    /**
     * Returns the *Singleton* instance of this class.
     *
     * @param array $options The list of property values of this instance.
     *
     * @return Translator The *Singleton* instance.
     */
    public static function getInstance($options = array())
    {
        if (is_null(self::$_instance)) {
            self::$_instance = new Translator($options);
        }
        return self::$_instance;
    }

    /**
     * Sets locale
     *
     * @param $locale
     *
     * @returns Translator
     */
    public function setLocale($locale)
    {
        $this->getConfiguration()->set('i18n.locale', $locale);
        return $this;
    }

    /**
     * Gets current configured locale
     *
     * @return string
     */
    public function getLocale()
    {
        return $this->configuration->
        get('i18n.locale', $this->fallbackLocale);
    }
}