Gettext\GettextTranslator Class Reference

Inheritance diagram for Gettext\GettextTranslator:

Collaboration diagram for Gettext\GettextTranslator:

Public Member Functions
	__construct ($language=null)
	Constructor. More...
	setLanguage ($language, $category=null)
	Define the current locale. More...
	loadDomain ($domain, $path=null, $default=true)
	Loads a gettext domain. More...
	gettext ($original)
	ngettext ($original, $plural, $value)
	dngettext ($domain, $original, $plural, $value)
	npgettext ($context, $original, $plural, $value)
	pgettext ($context, $original)
	dgettext ($domain, $original)
	dpgettext ($domain, $context, $original)
	dnpgettext ($domain, $context, $original, $plural, $value)
Public Member Functions inherited from Gettext\BaseTranslator
	register ()
	register ()
	Register this translator as global, to use with the gettext functions __(), p__(), etc. More...
	gettext ($original)
	Gets a translation using the original string. More...
	ngettext ($original, $plural, $value)
	Gets a translation checking the plural form. More...
	dngettext ($domain, $original, $plural, $value)
	Gets a translation checking the domain and the plural form. More...
	npgettext ($context, $original, $plural, $value)
	Gets a translation checking the context and the plural form. More...
	pgettext ($context, $original)
	Gets a translation checking the context. More...
	dgettext ($domain, $original)
	Gets a translation checking the domain. More...
	dpgettext ($domain, $context, $original)
	Gets a translation checking the domain and context. More...
	dnpgettext ($domain, $context, $original, $plural, $value)
	Gets a translation checking the domain, the context and the plural form. More...

Additional Inherited Members
Static Public Member Functions inherited from Gettext\BaseTranslator
static	initGettextFunctions (TranslatorInterface $translator)
	Set a translation instance as global, to use it with the gettext functions. More...
Static Public Attributes inherited from Gettext\BaseTranslator
static	$current

Detailed Description

Definition at line 5 of file GettextTranslator.php.

Constructor & Destructor Documentation

__construct()

Gettext\GettextTranslator::__construct

(

$language = null

)

Constructor.

Detects the current language using the environment variables.

Parameters

string

$language

Definition at line 12 of file GettextTranslator.php.

    {
        if (!function_exists('gettext')) {
            throw new \RuntimeException('This class require the gettext extension for PHP');
        }
 
        //detects the language environment respecting the priority order
        //http://php.net/manual/en/function.gettext.php#114062
        if (empty($language)) {
            $language = getenv('LANGUAGE') ?: getenv('LC_ALL') ?: getenv('LC_MESSAGES') ?: getenv('LANG');
        }
 
        if (!empty($language)) {
            $this->setLanguage($language);
        }
    }

Member Function Documentation

dgettext()

Gettext\GettextTranslator::dgettext	(		$domain,
			$original
	)

See also

TranslatorInterface

{Gets a translation checking the domain.

Parameters

string	$domain
string	$original

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 131 of file GettextTranslator.php.

    {
        return dgettext($domain, $original);
    }

References $domain.

dngettext()

Gettext\GettextTranslator::dngettext	(		$domain,
			$original,
			$plural,
			$value
	)

See also

TranslatorInterface

{Gets a translation checking the domain and the plural form.

Parameters

string	$domain
string	$original
string	$plural
string	$value

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 95 of file GettextTranslator.php.

    {
        return dngettext($domain, $original, $plural, $value);
    }

References $domain.

dnpgettext()

Gettext\GettextTranslator::dnpgettext	(		$domain,
			$context,
			$original,
			$plural,
			$value
	)

See also

TranslatorInterface

{Gets a translation checking the domain, the context and the plural form.

Parameters

string	$domain
string	$context
string	$original
string	$plural
string	$value

}

Implements Gettext\TranslatorInterface.

Definition at line 154 of file GettextTranslator.php.

    {
        $message = $context."\x04".$original;
        $translation = dngettext($domain, $message, $plural, $value);
 
        return ($translation === $message) ? $original : $translation;
    }

References $domain, and $message.

dpgettext()

Gettext\GettextTranslator::dpgettext	(		$domain,
			$context,
			$original
	)

See also

TranslatorInterface

{Gets a translation checking the domain and context.

Parameters

string	$domain
string	$context
string	$original

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 141 of file GettextTranslator.php.

    {
        $message = $context."\x04".$original;
        $translation = dgettext($domain, $message);
 
        return ($translation === $message) ? $original : $translation;
    }

References $domain, and $message.

gettext()

Gettext\GettextTranslator::gettext

(

$original

)

See also

TranslatorInterface

{Gets a translation using the original string.

Parameters

string

$original

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 75 of file GettextTranslator.php.

    {
        return gettext($original);
    }

loadDomain()

Gettext\GettextTranslator::loadDomain	(		$domain,
			$path = null,
			$default = true
	)

Loads a gettext domain.

Parameters

string	$domain
string	$path
bool	$default

Returns

self

Definition at line 58 of file GettextTranslator.php.

    {
        bindtextdomain($domain, $path);
        bind_textdomain_codeset($domain, 'UTF-8');
 
        if ($default) {
            textdomain($domain);
        }
 
        return $this;
    }

References $domain, and $path.

ngettext()

Gettext\GettextTranslator::ngettext	(		$original,
			$plural,
			$value
	)

See also

TranslatorInterface

{Gets a translation checking the plural form.

Parameters

string	$original
string	$plural
string	$value

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 85 of file GettextTranslator.php.

    {
        return ngettext($original, $plural, $value);
    }

npgettext()

Gettext\GettextTranslator::npgettext	(		$context,
			$original,
			$plural,
			$value
	)

See also

TranslatorInterface

{Gets a translation checking the context and the plural form.

Parameters

string	$context
string	$original
string	$plural
string	$value

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 105 of file GettextTranslator.php.

    {
        $message = $context."\x04".$original;
        $translation = ngettext($message, $plural, $value);
 
        return ($translation === $message) ? $original : $translation;
    }

References $message.

pgettext()

Gettext\GettextTranslator::pgettext	(		$context,
			$original
	)

See also

TranslatorInterface

{Gets a translation checking the context.

Parameters

string	$context
string	$original

Returns

string

}

Implements Gettext\TranslatorInterface.

Definition at line 118 of file GettextTranslator.php.

    {
        $message = $context."\x04".$original;
        $translation = gettext($message);
 
        return ($translation === $message) ? $original : $translation;
    }

References $message.

setLanguage()

Gettext\GettextTranslator::setLanguage	(		$language,
			$category = null
	)

Define the current locale.

Parameters

string	$language
int | null	$category

Returns

self

Definition at line 37 of file GettextTranslator.php.

    {
        if ($category === null) {
            $category = defined('LC_MESSAGES') ? LC_MESSAGES : LC_ALL;
        }
 
        setlocale($category, $language);
        putenv('LANGUAGE='.$language);
 
        return $this;
    }

References defined.

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/gettext/gettext/src/GettextTranslator.php