Inheritance diagram for Gettext\Translator:

Collaboration diagram for Gettext\Translator:

Public Member Functions
	loadTranslations ($translations)
	Loads translation from a Translations instance, a file on an array. 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...

Protected Member Functions
	addTranslations (array $translations)
	Set new translations to the dictionary. More...

	getTranslation ($domain, $context, $original)
	Search and returns a translation. More...

	isPlural ($domain, $n)
	Executes the plural decision code given the number to decide which plural version to take. More...

Static Private Member Functions
static	fixTerseIfs ($code, $inner=false)
	This function will recursively wrap failure states in brackets if they contain a nested terse if. More...

Private Attributes
	$domain

	$dictionary = array()

	$context_glue = "\004"

	$plurals = array()

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 7 of file Translator.php.

Member Function Documentation

◆ addTranslations()

Gettext\Translator::addTranslations ( array $translations )

protected

Set new translations to the dictionary.

Parameters

array $translations

Definition at line 136 of file Translator.php.

    {
        $info = isset($translations['']) ? $translations[''] : null;
        unset($translations['']);
 
        $domain = isset($info['domain']) ? $info['domain'] : 'messages';
 
        //Set the first domain loaded as default domain
        if (!$this->domain) {
            $this->domain = $domain;
        }
 
        if (!isset($this->dictionary[$domain])) {
            // If a plural form is set we extract those values
            $pluralForms = empty($info['plural-forms']) ? 'nplurals=2; plural=(n != 1)' : $info['plural-forms'];
 
            list($count, $code) = explode(';', $pluralForms, 2);
 
            // extract just the expression turn 'n' into a php variable '$n'.
            // Slap on a return keyword and semicolon at the end.
            $this->plurals[$domain] = array(
                'count' => (int) str_replace('nplurals=', '', $count),
                'code' => str_replace('plural=', 'return ', str_replace('n', '$n', $code)).';',
            );
 
            $this->dictionary[$domain] = $translations;
        } else {
            $this->dictionary[$domain] = array_replace_recursive($this->dictionary[$domain], $translations);
        }
    }

References $code, $domain, and $info.

◆ dgettext()

Gettext\Translator::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 93 of file Translator.php.

    {
        return $this->dpgettext($domain, null, $original);
    }

References $domain.

◆ dngettext()

Gettext\Translator::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 63 of file Translator.php.

    {
        return $this->dnpgettext($domain, null, $original, $plural, $value);
    }

References $domain.

◆ dnpgettext()

Gettext\Translator::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 119 of file Translator.php.

    {
        $key = $this->isPlural($domain, $value);
        $translation = $this->getTranslation($domain, $context, $original);
 
        if (isset($translation[$key]) && $translation[$key] !== '') {
            return $translation[$key];
        }
 
        return ($key === 1) ? $original : $plural;
    }

References $context, $domain, and $key.

◆ dpgettext()

Gettext\Translator::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 103 of file Translator.php.

    {
        $translation = $this->getTranslation($domain, $context, $original);
 
        if (isset($translation[1]) && $translation[1] !== '') {
            return $translation[1];
        }
 
        return $original;
    }

References $context, and $domain.

◆ fixTerseIfs()

static Gettext\Translator::fixTerseIfs	(	$code,
		$inner = `false`
	)

staticprivate

This function will recursively wrap failure states in brackets if they contain a nested terse if.

This because PHP can not handle nested terse if's unless they are wrapped in brackets.

This code probably only works for the gettext plural decision codes.

return ($n==1 ? 0 : $n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2); becomes return ($n==1 ? 0 : ($n%10>=2 && $n%10<=4 && ($n%100<10 || $n%100>=20) ? 1 : 2));

Parameters

string	$code	the terse if string
bool	$inner	If inner is true we wrap it in brackets

Returns: string A formatted terse If that PHP can work with.

Definition at line 228 of file Translator.php.

    {
        /*
         * (?P<expression>[^?]+)   Capture everything up to ? as 'expression'
         * \?                      ?
         * (?P<success>[^:]+)      Capture everything up to : as 'success'
         * :                       :
         * (?P<failure>[^;]+)      Capture everything up to ; as 'failure'
         */
        preg_match('/(?P<expression>[^?]+)\?(?P<success>[^:]+):(?P<failure>[^;]+)/', $code, $matches);
 
        // If no match was found then no terse if was present
        if (!isset($matches[0])) {
            return $code;
        }
 
        $expression = $matches['expression'];
        $success = $matches['success'];
        $failure = $matches['failure'];
 
        // Go look for another terse if in the failure state.
        $failure = self::fixTerseIfs($failure, true);
        $code = $expression.' ? '.$success.' : '.$failure;
 
        if ($inner) {
            return "($code)";
        }
 
        // note the semicolon. We need that for executing the code.
        return "$code;";
    }

References $code, $failure, and $success.

◆ gettext()

Gettext\Translator::gettext ( $original )

See also: TranslatorInterface

{Gets a translation using the original string.

Parameters

string $original

Returns: string

}

Implements Gettext\TranslatorInterface.

Definition at line 43 of file Translator.php.

    {
        return $this->dpgettext($this->domain, null, $original);
    }

◆ getTranslation()

Gettext\Translator::getTranslation	(	$domain,
		$context,
		$original
	)

protected

Search and returns a translation.

Parameters

string	$domain
string	$context
string	$original

Returns: array

Definition at line 176 of file Translator.php.

    {
        $key = isset($context) ? $context.$this->context_glue.$original : $original;
 
        return isset($this->dictionary[$domain][$key]) ? $this->dictionary[$domain][$key] : false;
    }

References $context, $domain, and $key.

◆ isPlural()

Gettext\Translator::isPlural	(	$domain,
		$n
	)

protected

Executes the plural decision code given the number to decide which plural version to take.

Parameters

string	$domain
string	$n

Returns: int

Definition at line 192 of file Translator.php.

    {
        //Not loaded domain, use a fallback
        if (!isset($this->plurals[$domain])) {
            return $n == 1 ? 1 : 2;
        }
 
        if (!isset($this->plurals[$domain]['function'])) {
            $this->plurals[$domain]['function'] = create_function('$n', self::fixTerseIfs($this->plurals[$domain]['code']));
        }
 
        if ($this->plurals[$domain]['count'] <= 2) {
            return (call_user_func($this->plurals[$domain]['function'], $n)) ? 2 : 1;
        }
 
        // We need to +1 because while (GNU) gettext codes assume 0 based,
        // this gettext actually stores 1 based.
        return (call_user_func($this->plurals[$domain]['function'], $n)) + 1;
    }

References $domain, and $n.

◆ loadTranslations()

Gettext\Translator::loadTranslations ( $translations )

Loads translation from a Translations instance, a file on an array.

Parameters

Translations | string | array $translations

Returns: self

Definition at line 21 of file Translator.php.

    {
        if (is_object($translations) && $translations instanceof Translations) {
            $translations = PhpArray::toArray($translations);
        } elseif (is_string($translations) && is_file($translations)) {
            $translations = include $translations;
        } elseif (!is_array($translations)) {
            throw new \InvalidArgumentException('Invalid Translator: only arrays, files or instance of Translations are allowed');
        }
 
        foreach ($translations as $translation) {
            $this->addTranslations($translation);
        }
 
        return $this;
    }

References ILIAS\UI\Implementation\Component\toArray().

Here is the call graph for this function:

◆ ngettext()

Gettext\Translator::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 53 of file Translator.php.

    {
        return $this->dnpgettext($this->domain, null, $original, $plural, $value);
    }

◆ npgettext()

Gettext\Translator::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 73 of file Translator.php.

    {
        return $this->dnpgettext($this->domain, $context, $original, $plural, $value);
    }

References $context.

◆ pgettext()

Gettext\Translator::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 83 of file Translator.php.

    {
        return $this->dpgettext($this->domain, $context, $original);
    }

References $context.

Field Documentation

◆ $context_glue

Gettext\Translator::$context_glue = "\004"

private

Definition at line 11 of file Translator.php.

◆ $dictionary

Gettext\Translator::$dictionary = array()

private

Definition at line 10 of file Translator.php.

◆ $domain

Gettext\Translator::$domain

private

Definition at line 9 of file Translator.php.

◆ $plurals

Gettext\Translator::$plurals = array()

private

Definition at line 12 of file Translator.php.

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

libs/composer/vendor/gettext/gettext/src/Translator.php

Public Member Functions

Protected Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addTranslations()

◆ dgettext()

◆ dngettext()

◆ dnpgettext()

◆ dpgettext()

◆ fixTerseIfs()

◆ gettext()

◆ getTranslation()

◆ isPlural()

◆ loadTranslations()

◆ ngettext()

◆ npgettext()

◆ pgettext()

Field Documentation

◆ $context_glue

◆ $dictionary

◆ $domain

◆ $plurals