Localization_Translator::translationExists() - Code Metrics - Mistralys/application-localization - Measure and Improve Code Quality continuously with Scrutinizer

Localization_Translator::translationExists() A
last analyzed 2024-10-22 14:10 UTC

↳ Parent: Localization_Translator
Complexity

Conditions	1
Paths	1
Size

Total Lines	3
Code Lines	1
Duplication

Lines	0
Ratio	0 %
Importance

Changes
Metric	Value
cc	1
eloc	1
nc	1
nop	1
dl	0
loc	3
rs	10
c	0
b	0
f	0
<?php
/**
 * File containing the {@link Localization_Translator} class.
 * @package Localization
 * @subpackage Translator
 * @see Localization_Translator
 */

declare(strict_types=1);

namespace AppLocalize;

use AppUtils\IniHelper;
use AppUtils\IniHelper_Exception;

/**
 * Application translation manager used to handle translating
 * application texts. Uses results from the {@link Localization_Parser}
 * class to determine which strings can be translated.
 *
 * Translations for each locale are stored in a separate file
 * and loaded as needed. The API allows adding new translations
 * and saving them to disk.
 *
 * @package Localization
 * @subpackage Translator
 * @author Sebastian Mordziol <[email protected]>
 * @link http://www.mistralys.com
 */
class Localization_Translator
{
    const ERROR_NO_STRINGS_AVAILABLE_FOR_LOCALE = 333101;
    const ERROR_CANNOT_SAVE_LOCALE_FILE = 333102;
    const ERROR_CANNOT_PARSE_LOCALE_FILE = 333103;
    
    /**
     * @var Localization_Locale
     */
    private $targetLocale;

    /**
     * Collection of strings per locale, associative array
     * with locale name => string pairs.
     *
     * @var array<string,string[]>
     */
    private $strings = array();

    /**
     * @var string|null
     */
    private $targetLocaleName = null;

    /**
     * @var array<string,string>
     */
    protected $reverseStrings = array();

    /**
    * @var Localization_Source[]
    */
    private $sources = array();

    /**
     * Indexed array with locale names for which the strings
     * have been loaded, used to avoid loading them repeatedly.
     *
     * @var array
     */
    private $loaded = array();

    public function addSource(Localization_Source $source) : void
    {
        $this->sources[] = $source;
    }

    /**
     * @param Localization_Source[] $sources
     */
    public function addSources(array $sources) : void
    {
        foreach($sources as $source) {
            $this->addSource($source);
        }
    }

    /**
     * Sets the locale to translate strings to. If this is
     * not the same as the currently selected locale, this
     * triggers loading the locale's strings file.
     *
     * @param Localization_Locale $locale
     * @throws Localization_Exception
     */
    public function setTargetLocale(Localization_Locale $locale) : void
    {
        // don't do anything if it's the same locale
        if (isset($this->targetLocale) && $locale->getName() == $this->targetLocale->getName()) {
            return;
        }

        $this->targetLocale = $locale;
        $this->targetLocaleName = $locale->getName();
        $this->load($locale);
    }

    /**
     * Loads the strings for the specified locale if the
     * according storage file exists.
     *
     * @param Localization_Locale $locale
     * @return boolean
     * @throws Localization_Exception
     */
    protected function load(Localization_Locale $locale) : bool
    {
        // initialize the storage array regardless of success
        $localeName = $locale->getName();
        if (in_array($localeName, $this->loaded)) {
            return true;
        }

        if (!isset($this->strings[$localeName])) {
            $this->strings[$localeName] = array();
        }

        foreach($this->sources as $source)
        {
            $file = $this->resolveStorageFile($locale, $source);
            if (!file_exists($file)) {
                continue;
            }
            
            $data = parse_ini_file($file, false);
            
            if($data === false) 
            {
                throw new Localization_Exception(
                    'Malformatted localization file',
                    sprintf(
                        'The localization ini file %1$s cannot be parsed.',
                        $file
                    ),
                    self::ERROR_CANNOT_PARSE_LOCALE_FILE
                );
            }
    
            $this->strings[$localeName] = array_merge(
                $this->strings[$localeName],
                $data
            );
        }
        
        $this->loaded[] = $localeName;
        
        return true;
    }

    /**
     * Saves the current string collections for the target
     * locale to disk. The format is the regular PHP .ini
     * format with string hash => text pairs without sections.
     *
     * These files may be edited manually as well if needed,
     * but new strings can only be added via the UI because
     * the hashes have to be created.
     *
     * @param Localization_Source $source
     * @param Localization_Scanner_StringsCollection $collection
     */
    public function save(Localization_Source $source, Localization_Scanner_StringsCollection $collection) : void
    {
        // the serverside strings file gets all available hashes,
        // which are filtered by source.
        $this->renderStringsFile(
            'Serverside',
            $source,
            $collection->getHashes(),
            $this->resolveStorageFile($this->targetLocale, $source),
            $this->targetLocale
        );
        
        // the clientside strings file only gets the JS hashes.
        $this->renderStringsFile(
            'Clientside',
            $source,
            $collection->getHashesByLanguageID('Javascript'),
            $this->getClientStorageFile($this->targetLocale, $source),
            $this->targetLocale,
            false
        );
    }
    
   /**
    * Retrieves all available strings for the specified locale,
    * as hash => text value pairs.
    * 
    * @param Localization_Locale $locale
    * @throws Localization_Exception
    * @return string[]
    */
    public function getStrings(Localization_Locale $locale) : array
    {
        $this->load($locale);
        
        $name = $locale->getName();
        
        if(isset($this->strings[$name])) {
            return $this->strings[$name];
        }
        
        throw new Localization_Exception(
            'No strings available for '.$name,
            sprintf(
                'Tried getting strings for the locale [%s], but it has no strings. Available locales are: [%s].',
                $name,
                implode(', ', array_keys($this->strings))
            ),
            self::ERROR_NO_STRINGS_AVAILABLE_FOR_LOCALE
        );
    }

    /**
     * @param Localization_Locale $locale
     * @return bool
     * @throws Localization_Exception
     */
    public function hasStrings(Localization_Locale $locale) : bool
    {
        $this->load($locale);
        
        return !empty($this->strings[$locale->getName()]);
    }

    /**
     * @param string $type
     * @param Localization_Source $source
     * @param Localization_Scanner_StringHash[] $hashes
     * @param string $file
     * @param Localization_Locale $locale
     * @param boolean $editable
     */
    protected function renderStringsFile(string $type, Localization_Source $source, array $hashes, string $file, Localization_Locale $locale, bool $editable=true) : void
    {
        $writer = new Localization_Writer($locale, $type, $file);

        if($editable)
        {
            $writer->makeEditable();
        }
        
        $sourceID = $source->getID();
        
        foreach ($hashes as $hash) 
        {
            if(!$hash->hasSourceID($sourceID)) {
                continue;
            }
            
            $text = $this->getHashTranslation($hash->getHash(), $locale);

            // skip any empty strings
            if($text === null || trim($text) == '') {
                continue;
            }
            
            $writer->addHash($hash->getHash(), $text);
        }
        
        $writer->writeFile();
    }

    /**
     * Retrieves the full path to the strings storage ini file.
     *
     * @param Localization_Locale $locale
     * @param Localization_Source $source
     * @return string
     */
    protected function resolveStorageFile(Localization_Locale $locale, Localization_Source $source) : string
    {
        return sprintf(
            '%1$s/%2$s-%3$s-server.ini',
            $source->getStorageFolder(),
            $locale->getName(),
            $source->getAlias()
        );
    }

    /**
     * Retrieves the full path to the strings storage ini file
     * for the clientside strings.
     *
     * @param Localization_Locale $locale
     * @param Localization_Source $source
     * @return string
     */
    protected function getClientStorageFile(Localization_Locale $locale, Localization_Source $source) : string
    {
        return sprintf(
            '%1$s/%2$s-%3$s-client.ini',
            $source->getStorageFolder(),
            $locale->getName(),
            $source->getAlias()
        );
    }

    /**
     * Sets the translation for a specific string hash
     * @param string $hash
     * @param string $text
     */
    public function setTranslation(string $hash, string $text) : void
    {
        $this->strings[$this->targetLocale->getName()][$hash] = $text;
    }

    /**
     * Clears a translation for the specified string hash
     * @param string $hash
     */
    public function clearTranslation(string $hash) : void
    {
        unset($this->strings[$this->targetLocale->getName()][$hash]);
    }

    /**
     * Translates a string. The first parameter has to be the string
     * to translate, additional parameters are variables to insert
     * into the string.
     *
     * @param string $text
     * @param array $args
     * @return string
     * @throws Localization_Exception
     */
    public function translate(string $text, array $args) : string
    {
        // to avoid re-creating the hash for the same texts over and over,
        // we keep track of the hashes we created, and re-use them.
        if(isset($this->reverseStrings[$text])) {
            $hash = $this->reverseStrings[$text];
        } else {
            $hash = md5($text);
            $this->reverseStrings[$text] = $hash;
        }

        // replace the text with the one we have on record, otherwise
        // simply leave the original unchanged.
        if (isset($this->strings[$this->targetLocaleName][$hash])) {
            $text = $this->strings[$this->targetLocaleName][$hash];
        }

        array_unshift($args, $text);

        $result = call_user_func('sprintf', ...$args);
        if (is_string($result)) {
            return $result;
        }

        throw new Localization_Exception(
            'Incorrectly translated string or erroneous localized string',
            sprintf(
                'The string %1$s seems to have too many or too few arguments.',
                $text
            )
        );
    }

    /**
     * Checks if the specified string hash exists.
     * @param string $hash
     * @return boolean
     */
    public function hashExists(string $hash) : bool
    {
        return array_key_exists($hash, $this->strings[$this->targetLocale->getName()]);
    }

    /**
     * Checks if a translation for the specified string hash exists.
     * @param string $text
     * @return boolean
     */
    public function translationExists(string $text) : bool
    {
        return array_key_exists(md5($text), $this->strings[$this->targetLocale->getName()]);
    }

    /**
     * Retrieves the locale into which texts are currently translated.
     * @return Localization_Locale
     */
    public function getTargetLocale() : Localization_Locale
    {
        return $this->targetLocale;
    }

    /**
     * Retrieves the translation for the specified string hash.
     *
     * @param string $hash
     * @param Localization_Locale|null $locale
     * @return string|NULL
     */
    public function getHashTranslation(string $hash, ?Localization_Locale $locale=null) : ?string
    {
        if(!$locale) {
            $locale = $this->targetLocale;
        }
        
        $localeName = $locale->getName();
        
        if(isset($this->strings[$localeName]) && isset($this->strings[$localeName][$hash])) {
            return $this->strings[$localeName][$hash];
        }

        return null;
    }

    /**
     * Retrieves only the strings that are available clientside.
     *
     * @param Localization_Locale $locale
     * @return array<string,string>
     * @throws IniHelper_Exception
     */
    public function getClientStrings(Localization_Locale $locale) : array
    {
        $result = array();
        
        foreach($this->sources as $source) 
        {
            $localeFile = self::getClientStorageFile($locale, $source);
            $localeFile = self::getClientStorageFile($locale, $source);
            if(!file_exists($localeFile)) {
                continue;
            }

            $strings = IniHelper::createFromFile($localeFile)->toArray();

            $result = array_merge($result, $strings);
        }
        
        return $result;
    }
}
Mistralys / application-localization

Localization_Translator::translationExists() A last analyzed 2024-10-22 14:10 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Localization_Translator::translationExists() A
last analyzed 2024-10-22 14:10 UTC
