Bluz\Translator\Translator

Complexity

Total Complexity

15

Size/Duplication

Total Lines	180
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Test Coverage

Coverage

97.56%

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	setDomain()	0	4	1
A	setLocale()	0	4	1
A	setPath()	0	4	1
A	init()	0	21	3
A	addTextDomain()	0	12	2
A	translate()	0	16	4
A	translatePlural()	0	16	3

<?php
/**
 * Bluz Framework Component
 *
 * @copyright Bluz PHP Team
 * @link      https://github.com/bluzphp/framework
 */

declare(strict_types=1);

namespace Bluz\Translator;

use Bluz\Common\Exception\ConfigurationException;
use Bluz\Common\Options;

/**
 * Translator based on gettext library
 *
 * @package  Bluz\Translator
 * @author   Anton Shevchuk
 * @link     https://github.com/bluzphp/framework/wiki/Translator
 */
class Translator
{
    use Options;

    /**
     * Locale
     *
     * @var string
     * @link http://www.loc.gov/standards/iso639-2/php/code_list.php
     */
    protected $locale = 'en_US';

    /**
     * @var string text domain
     */
    protected $domain = 'messages';

    /**
     * @var string path to text domain files
     */
    protected $path;

    /**
     * Set domain
     *
     * @param  string $domain
     *
     * @return void
     */
    public function setDomain($domain): void
    {
        $this->domain = $domain;
    }

    /**
     * Set locale
     *
     * @param  string $locale
     *
     * @return void
     */
    public function setLocale($locale): void
    {
        $this->locale = $locale;
    }

    /**
     * Set path to l10n
     *
     * @param  string $path
     *
     * @return void
     */
    public function setPath($path): void
    {
        $this->path = $path;
    }

    /**
     * Initialization
     *
     * @return void
     * @throws ConfigurationException
     * @throw  \Bluz\Config\ConfigException
     */
    public function init(): void
    {
        // Setup locale
        putenv('LC_ALL=' . $this->locale);
        putenv('LANG=' . $this->locale);
        putenv('LANGUAGE=' . $this->locale);

        // Windows workaround
        \defined('LC_MESSAGES') ?: \define('LC_MESSAGES', 6);

        setlocale(LC_MESSAGES, $this->locale);

        // For gettext only
        if (\function_exists('gettext')) {
            // Setup domain path
            $this->addTextDomain($this->domain, $this->path);

            // Setup default domain
            textdomain($this->domain);
        }
    }

    /**
     * Add text domain for gettext
     *
     * @param  string $domain of text for gettext setup
     * @param  string $path   on filesystem
     *
     * @return void
     * @throws ConfigurationException
     */
    public function addTextDomain($domain, $path): void
    {
        // check path
        if (!is_dir($path)) {
            throw new ConfigurationException("Translator configuration path `$path` not found");
        }

        bindtextdomain($domain, $path);

        // @todo: hardcoded codeset
        bind_textdomain_codeset($domain, 'UTF-8');
    }

    /**
     * Translate message
     *
     * Simple example of usage
     * equal to gettext('Message')
     *
     *     Translator::translate('Message');
     *
     * Simple replace of one or more argument(s)
     * equal to sprintf(gettext('Message to %s'), 'Username')
     *
     *     Translator::translate('Message to %s', 'Username');
     *
     * @param  string   $message
     * @param  string[] ...$text
     *
     * @return string
     */
    public static function translate(string $message, ...$text): string
    {
        if (empty($message)) {
            return $message;
        }

        if (\function_exists('gettext')) {
            $message = gettext($message);
        }

        if (\func_num_args() > 1) {
            $message = vsprintf($message, $text);
        }

        return $message;
    }

    /**
     * Translate plural form
     *
     * Example of usage plural form + sprintf
     * equal to sprintf(ngettext('%d comment', '%d comments', 4), 4)
     *     Translator::translatePlural('%d comment', '%d comments', 4)
     *
     * Example of usage plural form + sprintf
     * equal to sprintf(ngettext('%d comment', '%d comments', 4), 4, 'Topic')
     *     Translator::translatePlural('%d comment to %s', '%d comments to %s', 4, 'Topic')
     *
     * @param  string   $singular
     * @param  string   $plural
     * @param  integer  $number
     * @param  string[] ...$text
     *
     * @return string
     * @link   http://docs.translatehouse.org/projects/localization-guide/en/latest/l10n/pluralforms.html
     */
    public static function translatePlural(string $singular, string $plural, $number, ...$text): string
    {
        if (\function_exists('ngettext')) {
            $message = ngettext($singular, $plural, $number);
        } else {
            $message = $singular;
        }

        if (\func_num_args() > 3) {
            // first element is number
            array_unshift($text, $number);
            $message = vsprintf($message, $text);
        }

        return $message;
    }
}