Gettext

Complexity

Total Complexity

24

Size/Duplication

Total Lines	216
Duplicated Lines	11.57 %

Coupling/Cohesion

Components	1
Dependencies	0

Test Coverage

Coverage

100%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	changeCategory()	0	8	1
A	__construct()	0	14	1
B	_setConfig()	0	17	6
A	changeDomain()	0	12	1
A	_bindTextDomainCodeSet()	0	13	2
A	_bindTextDomain()	13	13	2
A	_textDomain()	0	11	2
A	_setLocale()	0	16	3
B	_putEnv()	0	22	4
A	_checkLocaleFile()	12	12	2

<?php
// @codeCoverageIgnoreStart
defined('BASEPATH') || exit('No direct script access allowed');
// @codeCoverageIgnoreEnd

/**
 * Codeigniter PHP framework library class for dealing with gettext.
 *
 * @package    CodeIgniter
 * @subpackage Libraries
 * @category   Language
 * @author     Joël Gaujard <joel@depiltech.com>
 * @author     Marko Martinović <marko@techytalk.info>
 * @link       https://github.com/joel-depiltech/codeigniter-gettext
 */
class Gettext
{
    /** @var string domain name match with file contains translation */
    private $_textDomain;

    /** @var string character encoding in which the messages are */
    private $_catalogCodeSet;

    /** @var string the path for a domain */
    private $_localeDir;

    /** @var string|array locale or array of locales */
    private $_locale;

    /** @var string constant specifying the category of the functions affected by the locale setting */
    private $_category;

    /**
     * Initialize Codeigniter PHP framework and get configuration
     *
     * @param array $config Override default configuration
     */
    public function __construct(array $config = array())
    {
        log_message('info', 'Gettext Library Class Initialized');

        $this->_setConfig($config);

        $this
            ->_bindTextDomainCodeSet()
            ->_bindTextDomain()
            ->_textDomain()
            ->_setLocale()
            ->_putEnv()
            ->_checkLocaleFile();
    }

    /**
     * Merge config as parameter and default config (config/gettext.php file)
     *
     * @param array $config
     */
    private function _setConfig(array $config = array())
    {
        $this->_localeDir = isset($config['gettext_locale_dir'])
            ? $config['gettext_locale_dir'] : config_item('gettext_locale_dir');

        $this->_textDomain = isset($config['gettext_text_domain'])
            ? $config['gettext_text_domain'] : config_item('gettext_text_domain');

        $this->_catalogCodeSet = isset($config['gettext_catalog_codeset'])
            ? $config['gettext_catalog_codeset'] : config_item('gettext_catalog_codeset');

        $this->_locale = isset($config['gettext_locale'])
            ? $config['gettext_locale'] : config_item('gettext_locale');

        $this->_category = (isset($config['gettext_category'])
            ? $config['gettext_category'] : config_item('gettext_category'));
    }

    /**
     * Load a domain
     *
     * @param string $domain
     */
    public function changeDomain($domain)
    {
        log_message('info', 'Gettext Library Class -> Change domain');

        $this->_textDomain = $domain;

        $this
            ->_bindTextDomainCodeSet()
            ->_bindTextDomain()
            ->_textDomain()
            ->_checkLocaleFile();
    }

    /**
     * Switch to a category
     *
     * @param string $category
     */
    public function changeCategory($category)
    {
        log_message('info', 'Gettext Library Class -> Change category');

        $this->_category = $category;

        $this->_setLocale();
    }

    /**
     * Gettext catalog codeset
     *
     * @return $this
     */
    private function _bindTextDomainCodeSet()
    {
        $isBindTextDomainCodeSet = bind_textdomain_codeset($this->_textDomain, $this->_catalogCodeSet);

        log_message(
            (is_string($isBindTextDomainCodeSet) ? 'info' : 'error'),
            'Gettext Library -> Bind ' .
            'text domain: ' . $this->_textDomain . ' - ' .
            'with code set: ' . $this->_catalogCodeSet
        );

        return $this;
    }

    /**
     * Path to gettext locales directory relative to APPPATH
     *
     * @return $this
     */
    private function _bindTextDomain()
    {
        $isBindTextDomain = bindtextdomain($this->_textDomain, APPPATH . $this->_localeDir);

        log_message(
            (is_string($isBindTextDomain) ? 'info' : 'error'),
            'Gettext Library -> Bind ' .
            'text domain: ' . $this->_textDomain . ' - ' .
            'with directory: ' . APPPATH . $this->_localeDir
        );

        return $this;
    }

    /**
     * Gettext domain
     *
     * @return $this
     */
    private function _textDomain()
    {
        $isSetTextDomain = textdomain($this->_textDomain);

        log_message(
            (is_string($isSetTextDomain) ? 'info' : 'error'),
            'Gettext Library -> Set text domain: ' . $this->_textDomain
        );

        return $this;
    }

    /**
     * Gettext locale
     *
     * @return $this
     */
    private function _setLocale()
    {
        $isSetLocale = setlocale(constant($this->_category), $this->_locale);

        log_message(
            (is_string($isSetLocale) ? 'info' : 'error'),
            'Gettext Library -> ' .
            'Set locale: ' . (is_array($this->_locale) ? print_r($this->_locale, TRUE) : $this->_locale) . ' ' .
            'for category: ' . $this->_category
        );

        // the new current locale, or FALSE if the locale is not implemented on your platform
        $this->_locale = $isSetLocale;

        return $this;
    }

    /**
     * Change environment language for CLI
     *
     * @return $this
     */
    private function _putEnv()
    {
        $isPutEnv = putenv('LANGUAGE=' . $this->_locale);
        log_message(
            ($isPutEnv ? 'info' : 'error'),
            'Gettext Library -> Set environment LANGUAGE: ' . $this->_locale
        );

        $isPutEnv = putenv('LANG=' . $this->_locale);
        log_message(
            ($isPutEnv ? 'info' : 'error'),
            'Gettext Library -> Set environment LANG: ' . $this->_locale
        );

        $isPutEnv = putenv($this->_category . '=' . $this->_locale);
        log_message(
            ($isPutEnv ? 'info' : 'error'),
            'Gettext Library -> Set environment category ' . $this->_category . ': ' . $this->_locale
        );

        return $this;
    }

    /**
     * MO file exists for locale
     *
     * @return $this
     */
    private function _checkLocaleFile()
    {
        $file = APPPATH . $this->_localeDir .
            '/' . $this->_locale . '/LC_MESSAGES/' . $this->_textDomain . '.mo';

        log_message(
            (is_file($file) ? 'info' : 'error'),
            'Gettext Library -> Check MO file exists: ' . $file
        );

        return $this;
    }

}


/* End of file Gettext.php */
/* Location: ./application/libraries/Gettext.php */