Jaxon\Utils\Translation\Translator

Complexity

Total Complexity

18

Size/Duplication

Total Lines	153
Duplicated Lines	0 %

Importance

Changes	3
Bugs	0	Features	0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	setLocale()	0	5	2
A	trans()	0	20	4
A	_loadTranslations()	0	15	4
A	translations()	0	17	4
A	loadTranslations()	0	21	4

<?php

/**
 * Translator.php - Translator
 *
 * Provide translation service for strings in the Jaxon library.
 *
 * @package jaxon-utils
 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2022 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

namespace Jaxon\Utils\Translation;

use function array_keys;
use function array_map;
use function array_merge;
use function array_values;
use function explode;
use function file_exists;
use function is_array;
use function str_replace;
use function trim;

class Translator
{
    /**
     * The default locale
     *
     * @var string
     */
    protected $sDefaultLocale = 'en';

    /**
     * The translations in a flattened array
     *
     * @var array
     */
    protected $aTranslations = [];

    /**
     * The translations as received as input
     *
     * @var array
     */
    protected $aRawTranslations = [];

    /**
     * Set the default locale
     *
     * @param string $sLocale
     *
     * @return void
     */
    public function setLocale(string $sLocale): void
    {
        if(($sLocale = trim($sLocale)))
        {
            $this->sDefaultLocale = $sLocale;
        }
    }

    /**
     * Recursively load translated strings from an array
     *
     * @param string $sLanguage The language of the translations
     * @param string $sPrefix The prefix for names
     * @param array $aTranslations The translated strings
     *
     * @return void
     */
    private function _loadTranslations(string $sLanguage, string $sPrefix, array $aTranslations): void
    {
        foreach($aTranslations as $sKey => $xTranslation)
        {
            $sKey = trim($sKey);
            $sKey = ($sPrefix) ? $sPrefix . '.' . $sKey : $sKey;
            if(is_array($xTranslation))
            {
                // Recursively read the translations in the array
                $this->_loadTranslations($sLanguage, $sKey, $xTranslation);
            }
            else
            {
                // Save this translation
                $this->aTranslations[$sLanguage][$sKey] = $xTranslation;
            }
        }
    }

    /**
     * Load translated strings from a file
     *
     * @param string $sFilePath The file full path
     * @param string $sLanguage The language of the strings in this file
     *
     * @return bool
     */
    public function loadTranslations(string $sFilePath, string $sLanguage): bool
    {
        if(!file_exists($sFilePath))
        {
            return false;
        }
        $aTranslations = require($sFilePath);
        if(!is_array($aTranslations))
        {
            return false;
        }

        // Load the translations
        if(!isset($this->aTranslations[$sLanguage]))
        {
            $this->aTranslations[$sLanguage] = [];
        }
        $this->aRawTranslations[$sLanguage] =
            array_merge($this->aRawTranslations[$sLanguage] ?? [], $aTranslations);
        $this->_loadTranslations($sLanguage, '', $aTranslations);
        return true;
    }

    /**
     * Get a translated string
     *
     * @param string $sText The key of the translated string
     * @param array $aPlaceHolders The placeholders of the translated string
     * @param string $sLanguage The language of the translated string
     *
     * @return string
     */
    public function trans(string $sText, array $aPlaceHolders = [], string $sLanguage = ''): string
    {
        $sText = trim($sText);
        if(empty($sLanguage))
        {
            $sLanguage = $this->sDefaultLocale;
        }
        if(!isset($this->aTranslations[$sLanguage][$sText]))
        {
            return $sText;
        }
        $sMessage = $this->aTranslations[$sLanguage][$sText];
        if(!empty($aPlaceHolders))
        {
            $aVars = array_map(function($sVar) {
                return ':' . $sVar;
            }, array_keys($aPlaceHolders));
            $sMessage = str_replace($aVars, array_values($aPlaceHolders), $sMessage);
        }
        return $sMessage;
    }

    /**
     * Get all the translations under a given key
     *
     * @param string $sKey
     * @param string $sLanguage
     *
     * @return array
     */
    public function translations(string $sKey, string $sLanguage = ''): array
    {
        if(empty($sLanguage))
        {
            $sLanguage = $this->sDefaultLocale;
        }
        $aKeys = explode('.', $sKey);

        $aTranslations = $this->aRawTranslations[$sLanguage];
        foreach($aKeys as $sKey)
        {
            if($sKey !== '')
            {
                $aTranslations = $aTranslations[$sKey] ?? [];
            }
        }
        return $aTranslations;
    }
}