The process state native gettext (PHP extension "gettext") needs to serve the compiled catalogs of the migrated modules, and the one place that calls it. More...

Collaboration diagram for ILIAS\Language\ComponentTranslation\NativeGettext:

Static Public Member Functions
static	isExtensionLoaded ()

static	isThreadSafe ()
	Whether PHP is thread-safe (ZTS): the settings of activate() then apply to every thread and are not taken back. More...

static	useThreadSafeForTests (?bool $thread_safe)
	Makes isThreadSafe() return $thread_safe (`null`: PHP_ZTS again) - for tests only. More...

static	usesSystemLocale ()
	macOS/BSD: activate() uses a SYSTEM_LOCALES entry, their C library ignores LOCPATH. More...

static	useSystemLocaleForTests (?bool $system_locale)
	Makes usesSystemLocale() return $system_locale (`null`: by PHP_OS_FAMILY again) - for tests only. More...

static	activate (string $locale_directory)
	Sets LANGUAGE and, if LC_MESSAGES holds no real locale, the locale LOCALE_NAME of $locale_directory (or, see usesSystemLocale(), a system locale) for it; if it fails, getProblem() tells why. More...

static	isActive ()
	Whether activate() succeeded and its settings are still in place (other code, e.g. More...

static	reactivateIfLost ()
	Activates the locale again if it was activated before and the settings changed since. More...

static	restore ()
	Takes LANGUAGE, LC_MESSAGES (if activate() set it) and LC_ALL back to the state before the first activate(); settings changed by other code since stay. More...

static	getProblem ()

static	bind (string $domain, string $directory)
	Binds $domain to $directory with the codeset UTF-8. More...

static	isLoaded (string $domain)
	Whether the catalog of the bound $domain is readable: its header (the translation of the empty message id) is not empty. More...

static	translate (string $domain, string $message_id)
	The translation of $message_id in $domain, or $message_id itself if there is none (as the C library answers), also for an empty or too long $message_id. More...

static	translatePlural (string $domain, string $message_id, int $n)
	The form of the plural message $message_id the "Plural-Forms" rule of the catalog selects for $n (a negative $n counts as its absolute value), or $message_id itself if there is none. More...

static	resetForTests ()
	Forgets the activation (without taking the settings back) - for tests only. More...

Data Fields
const string	LOCALE_NAME = 'ilias_messages'

const array	SYSTEM_LOCALES = ['en_US.UTF-8', 'en_US.utf8']
	LC_MESSAGES candidates where the system locale is used, see usesSystemLocale(). More...

const string	CATALOG_LANGUAGE = 'messages'
	The value of LANGUAGE: the directory below a bound directory the catalogs are looked up in. More...

const string	CATALOG_DIRECTORY = self::CATALOG_LANGUAGE . '/LC_MESSAGES'

Static Private Member Functions
static	activateSystemLocale (string $locale_directory)

static	keptLocale ()
	A real LC_MESSAGES locale stays, so ICU & Co. More...

static	processState ()

static	activated (string $locale_directory, string $locale, bool $messages_set)

static	canLookUp (string $message_id)

Private Attributes
const array	SYSTEM_LOCALE_OS_FAMILIES = ['Darwin', 'BSD']

const string	CODESET = 'UTF-8'

const int	MAX_MESSAGE_LENGTH = 4096
	Longer message ids are refused by PHP (ValueError), so they are never found. More...

Static Private Attributes
static string	$locale_directory = null

static string	$active_locale = null
	What setlocale() returned in the last successful activate(). More...

static array	$previous = null

static bool	$thread_safe_for_tests = null

static bool	$system_locale_for_tests = null

static string	$problem = null

static bool	$messages_set = false

Detailed Description

The process state native gettext (PHP extension "gettext") needs to serve the compiled catalogs of the migrated modules, and the one place that calls it.

Native gettext only translates while LC_MESSAGES is not "C"/"POSIX" and finds a catalog as <bound directory>/<language>/LC_MESSAGES/<domain>.mo. ILIAS does not depend on the locale's language, so a real locale in LC_MESSAGES (e.g. of ilInitialisation::initLocale()) stays. Only for "C"/"POSIX"/"C.<codeset>":

glibc: the build ships its own locale (a copy of "C.utf8", see ShippedTranslationsBuild) named LOCALE_NAME; activate() loads it via LOCPATH and removes LOCPATH again right away (while it is set, setlocale() finds no system locale);
macOS/BSD (see usesSystemLocale()): the C library ignores LOCPATH, gettext comes from GNU libintl, so activate() sets the first existing of SYSTEM_LOCALES for LC_MESSAGES and the environment variable LC_ALL (GNU libintl ignores LANGUAGE for "C.<codeset>");
LANGUAGE is CATALOG_LANGUAGE, so "<language>" is always "messages"; the language of a catalog is part of its domain ("<module>.<lang>", see MigratedLanguageFilePaths), as the C library caches per process and a later LANGUAGE change would not reliably switch catalogs;
every domain is bound with codeset UTF-8, so LC_CTYPE never converts a value.

Both settings are process-wide. PHP takes them back at the end of every request (putenv() variables, setlocale() reset to "C"), so no shutdown function is needed (it would stop later shutdown functions from translating). In a thread-safe (ZTS) PHP the end of another thread's request can take them back mid-request: isActive() checks, reactivateIfLost() activates again (the administration shows a hint, see isThreadSafe()). Child processes inherit LANGUAGE=messages, which is harmless, and on macOS/BSD LC_ALL=<active locale> (a kept one too, e.g. the locale of the administration), which overrides the locale of the environment for them.

The C library never reloads a catalog file it has read once (also not a replaced one), so every new state (a build, an overlay revision) gets a directory of its own, and binding the domain loads it.

Definition at line 52 of file NativeGettext.php.

Member Function Documentation

◆ activate()

static ILIAS\Language\ComponentTranslation\NativeGettext::activate ( string $locale_directory )

static

Sets LANGUAGE and, if LC_MESSAGES holds no real locale, the locale LOCALE_NAME of $locale_directory (or, see usesSystemLocale(), a system locale) for it; if it fails, getProblem() tells why.

Definition at line 136 of file NativeGettext.php.

                                                             : bool
    {
        if (!self::isExtensionLoaded()) {
            self::$problem = 'the PHP extension "gettext" is not loaded in this PHP (the web server needs it like the CLI that ran the build)';
            return false;
        }
        if (self::$locale_directory === $locale_directory && self::isActive()) {
            return true;
        }
        if (self::usesSystemLocale()) {
            return self::activateSystemLocale($locale_directory);
        }
        // also checked when a real locale stays: a build without its locale is broken
        if (!is_dir($locale_directory . '/' . self::LOCALE_NAME)) {
            self::$problem = sprintf('the locale "%s" is missing in "%s"', self::LOCALE_NAME, $locale_directory);
            return false;
        }
 
        self::$previous ??= self::processState();
        $kept = self::keptLocale();
        if ($kept !== null) {
            return self::activated($locale_directory, $kept, false);
        }
        $locpath = getenv('LOCPATH');
        putenv('LOCPATH=' . $locale_directory);
        $locale = setlocale(LC_MESSAGES, self::LOCALE_NAME);
        // as long as LOCPATH is set, setlocale() finds no locale of the system (e.g. for LC_TIME)
        putenv($locpath === false ? 'LOCPATH' : 'LOCPATH=' . $locpath);
        if ($locale !== self::LOCALE_NAME) {
            self::$problem = sprintf('the locale "%s" of "%s" cannot be activated', self::LOCALE_NAME, $locale_directory);
            return false;
        }
 
        return self::activated($locale_directory, $locale, true);
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\$locale_directory, ILIAS\Language\ComponentTranslation\NativeGettext\activated(), ILIAS\Language\ComponentTranslation\NativeGettext\activateSystemLocale(), ILIAS\Language\ComponentTranslation\NativeGettext\keptLocale(), and ILIAS\Language\ComponentTranslation\NativeGettext\processState().

Referenced by ILIAS\Language\ComponentTranslation\NativeGettextTest\activateBuild(), ILIAS\Language\ComponentTranslation\NativeGettextTest\activateSystemLocale(), ILIAS\Language\ComponentTranslation\NativeGettext\reactivateIfLost(), ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testActivateFailsWithAProblemAndLeavesTheProcessAsItWas(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testActivateStillFailsWithoutLocaleDirectoryWhenARealLocaleStays(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testRestoreAfterARepeatedActivationGivesBackLcAllFromBeforeTheFirstOne(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testSystemLocaleBranchTranslatesWithoutLocaleDirectoryAndLeavesLocpathAlone().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ activated()

static ILIAS\Language\ComponentTranslation\NativeGettext::activated	(	string	$locale_directory,
		string	$locale,
		bool	$messages_set
	)

staticprivate

Definition at line 217 of file NativeGettext.php.

                                                                                                   : bool
    {
        putenv('LANGUAGE=' . self::CATALOG_LANGUAGE);
        self::$locale_directory = $locale_directory;
        self::$active_locale = $locale;
        self::$messages_set = $messages_set;
        self::$problem = null;
 
        return true;
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\$locale_directory, and ILIAS\Language\ComponentTranslation\NativeGettext\$messages_set.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activate(), and ILIAS\Language\ComponentTranslation\NativeGettext\activateSystemLocale().

Here is the caller graph for this function:

◆ activateSystemLocale()

static ILIAS\Language\ComponentTranslation\NativeGettext::activateSystemLocale ( string $locale_directory )

staticprivate

Definition at line 172 of file NativeGettext.php.

                                                                          : bool
    {
        self::$previous ??= self::processState();
        $kept = self::keptLocale();
        $locale = $kept ?? setlocale(LC_MESSAGES, self::SYSTEM_LOCALES);
        if ($locale === false) {
            self::$problem = sprintf(
                'none of the system locales %s exists for LC_MESSAGES (needed on %s, where native gettext cannot use the locale of the build)',
                implode(', ', self::SYSTEM_LOCALES),
                PHP_OS_FAMILY
            );
            return false;
        }
        // GNU libintl on macOS reads the locale of the environment before setlocale()'s, and "C" there ignores LANGUAGE
        putenv('LC_ALL=' . $locale);
 
        return self::activated($locale_directory, $locale, $kept === null);
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\$locale_directory, ILIAS\Language\ComponentTranslation\NativeGettext\activated(), ILIAS\Language\ComponentTranslation\NativeGettext\keptLocale(), and ILIAS\Language\ComponentTranslation\NativeGettext\processState().

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ bind()

static ILIAS\Language\ComponentTranslation\NativeGettext::bind	(	string	$domain,
		string	$directory
	)

static

Binds $domain to $directory with the codeset UTF-8.

Returns: bool false if the extension is missing or $directory does not exist

Definition at line 288 of file NativeGettext.php.

                                                                  : bool
    {
        return self::isExtensionLoaded()
            && @bindtextdomain($domain, $directory) !== false
            && @bind_textdomain_codeset($domain, self::CODESET) !== false;
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\isExtensionLoaded().

Referenced by ILIAS\Language\ComponentTranslation\NativeGettextTest\activateBuild(), ILIAS\Language\ComponentTranslation\NativeGettextTest\activateSystemLocale(), ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testBindRefusesADirectoryThatDoesNotExist(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testIsLoadedTellsAReadableCatalogOfOurOwnByItsHeader(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testSystemLocaleBranchTranslatesWithoutLocaleDirectoryAndLeavesLocpathAlone(), and ILIAS\Language\ComponentTranslation\TranslationGettextRepository\withOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canLookUp()

static ILIAS\Language\ComponentTranslation\NativeGettext::canLookUp ( string $message_id )

staticprivate

Definition at line 331 of file NativeGettext.php.

                                                         : bool
    {
        return $message_id !== '' && strlen($message_id) <= self::MAX_MESSAGE_LENGTH && self::isExtensionLoaded();
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\isExtensionLoaded().

Here is the call graph for this function:

◆ getProblem()

static ILIAS\Language\ComponentTranslation\NativeGettext::getProblem ( )

static

Definition at line 278 of file NativeGettext.php.

                                       : ?string
    {
        return self::$problem;
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\$problem.

Here is the caller graph for this function:

◆ isActive()

static ILIAS\Language\ComponentTranslation\NativeGettext::isActive ( )

static

Whether activate() succeeded and its settings are still in place (other code, e.g.

ilInitialisation::initLocale() with setlocale(LC_ALL, …), may have changed LC_MESSAGES since).

Definition at line 232 of file NativeGettext.php.

                                     : bool
    {
        return self::$locale_directory !== null
            && setlocale(LC_MESSAGES, '0') === self::$active_locale
            && getenv('LANGUAGE') === self::CATALOG_LANGUAGE
            && (!self::usesSystemLocale() || getenv('LC_ALL') === self::$active_locale);
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\$active_locale, and ILIAS\Language\ComponentTranslation\NativeGettext\usesSystemLocale().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isExtensionLoaded()

static ILIAS\Language\ComponentTranslation\NativeGettext::isExtensionLoaded ( )

static

Definition at line 92 of file NativeGettext.php.

                                              : bool
    {
        return extension_loaded('gettext');
    }

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\bind(), ILIAS\Language\ComponentTranslation\NativeGettext\canLookUp(), ILIAS\Language\ComponentTranslation\NativeGettext\isLoaded(), and ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state().

Here is the caller graph for this function:

◆ isLoaded()

static ILIAS\Language\ComponentTranslation\NativeGettext::isLoaded ( string $domain )

static

Whether the catalog of the bound $domain is readable: its header (the translation of the empty message id) is not empty.

Definition at line 299 of file NativeGettext.php.

                                                   : bool
    {
        return self::isExtensionLoaded() && dgettext($domain, '') !== '';
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\isExtensionLoaded().

Referenced by ILIAS\Language\ComponentTranslation\TranslationGettextRepository\state(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testIsLoadedTellsAReadableCatalogOfOurOwnByItsHeader(), and ILIAS\Language\ComponentTranslation\TranslationGettextRepository\withOverlay().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isThreadSafe()

static ILIAS\Language\ComponentTranslation\NativeGettext::isThreadSafe ( )

static

Whether PHP is thread-safe (ZTS): the settings of activate() then apply to every thread and are not taken back.

Definition at line 101 of file NativeGettext.php.

                                         : bool
    {
        return self::$thread_safe_for_tests ?? (bool) PHP_ZTS;
    }

Referenced by ILIAS\Language\ComponentTranslation\NativeGettextTest\testRestoreChangesNothingInAThreadSafePhp().

Here is the caller graph for this function:

◆ keptLocale()

static ILIAS\Language\ComponentTranslation\NativeGettext::keptLocale ( )

staticprivate

A real LC_MESSAGES locale stays, so ICU & Co.

keep seeing it (e.g. the one of ilInitialisation::initLocale()).

Definition at line 192 of file NativeGettext.php.

                                        : ?string
    {
        $locale = setlocale(LC_MESSAGES, '0');
        if (
            $locale === false
            || $locale === 'C'
            || $locale === 'POSIX'
            || str_starts_with($locale, 'C.')
            || $locale === self::LOCALE_NAME
            || (self::$messages_set && $locale === self::$active_locale)
        ) {
            return null;
        }
 
        return $locale;
    }

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activate(), and ILIAS\Language\ComponentTranslation\NativeGettext\activateSystemLocale().

Here is the caller graph for this function:

◆ processState()

static ILIAS\Language\ComponentTranslation\NativeGettext::processState ( )

staticprivate

Returns: array{language: string|false, messages: string|false, all: string|false}

Definition at line 212 of file NativeGettext.php.

                                          : array
    {
        return ['language' => getenv('LANGUAGE'), 'messages' => setlocale(LC_MESSAGES, '0'), 'all' => getenv('LC_ALL')];
    }

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activate(), and ILIAS\Language\ComponentTranslation\NativeGettext\activateSystemLocale().

Here is the caller graph for this function:

◆ reactivateIfLost()

static ILIAS\Language\ComponentTranslation\NativeGettext::reactivateIfLost ( )

static

Activates the locale again if it was activated before and the settings changed since.

Returns: bool whether it had to be (and could be) activated again - a lookup that found nothing is worth repeating then

Definition at line 246 of file NativeGettext.php.

                                             : bool
    {
        if (self::$locale_directory === null || self::isActive()) {
            return false;
        }
 
        return self::activate(self::$locale_directory);
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\activate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ resetForTests()

static ILIAS\Language\ComponentTranslation\NativeGettext::resetForTests ( )

static

Forgets the activation (without taking the settings back) - for tests only.

Definition at line 341 of file NativeGettext.php.

                                          : void
    {
        self::$thread_safe_for_tests = null;
        self::restore();
        self::$system_locale_for_tests = null;
        self::$locale_directory = null;
        self::$active_locale = null;
        self::$messages_set = false;
        self::$previous = null;
        self::$problem = null;
    }

References ILIAS\Language\ComponentTranslation\NativeGettext\restore().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ restore()

static ILIAS\Language\ComponentTranslation\NativeGettext::restore ( )

static

Takes LANGUAGE, LC_MESSAGES (if activate() set it) and LC_ALL back to the state before the first activate(); settings changed by other code since stay.

Only for long-running processes (e.g. Setup's build after its check), a web request needs no call. No-op in a thread-safe PHP, where other threads may use them. The activated directory is kept, so reactivateIfLost() can activate it again.

Definition at line 261 of file NativeGettext.php.

                                    : void
    {
        if (self::$previous === null || self::isThreadSafe()) {
            return;
        }
        if (self::$messages_set && self::$previous['messages'] !== false && setlocale(LC_MESSAGES, '0') === self::$active_locale) {
            setlocale(LC_MESSAGES, self::$previous['messages']);
        }
        if (getenv('LANGUAGE') === self::CATALOG_LANGUAGE) {
            putenv(self::$previous['language'] === false ? 'LANGUAGE' : 'LANGUAGE=' . self::$previous['language']);
        }
        if (self::usesSystemLocale() && getenv('LC_ALL') === self::$active_locale) {
            putenv(self::$previous['all'] === false ? 'LC_ALL' : 'LC_ALL=' . self::$previous['all']);
        }
        self::$previous = null;
    }

Here is the caller graph for this function:

◆ translate()

static ILIAS\Language\ComponentTranslation\NativeGettext::translate	(	string	$domain,
		string	$message_id
	)

static

The translation of $message_id in $domain, or $message_id itself if there is none (as the C library answers), also for an empty or too long $message_id.

Definition at line 308 of file NativeGettext.php.

                                                                        : string
    {
        if (!self::canLookUp($message_id)) {
            return $message_id;
        }
 
        return dgettext($domain, $message_id);
    }

Here is the caller graph for this function:

◆ translatePlural()

static ILIAS\Language\ComponentTranslation\NativeGettext::translatePlural	(	string	$domain,
		string	$message_id,
		int	$n
	)

static

The form of the plural message $message_id the "Plural-Forms" rule of the catalog selects for $n (a negative $n counts as its absolute value), or $message_id itself if there is none.

Definition at line 321 of file NativeGettext.php.

                                                                                      : string
    {
        if (!self::canLookUp($message_id)) {
            return $message_id;
        }
        $n = $n === PHP_INT_MIN ? PHP_INT_MAX : abs($n);
 
        return dngettext($domain, $message_id, $message_id, $n);
    }

Referenced by ILIAS\Language\ComponentTranslation\TranslationGettextRepository\getPluralText(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testTranslateAnswersTheMessageIdItself(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testTranslatePluralSelectsTheFormOfTheAbsoluteQuantity().

Here is the caller graph for this function:

◆ usesSystemLocale()

static ILIAS\Language\ComponentTranslation\NativeGettext::usesSystemLocale ( )

static

macOS/BSD: activate() uses a SYSTEM_LOCALES entry, their C library ignores LOCPATH.

Definition at line 117 of file NativeGettext.php.

                                             : bool
    {
        return self::$system_locale_for_tests ?? in_array(PHP_OS_FAMILY, self::SYSTEM_LOCALE_OS_FAMILIES, true);
    }

Referenced by ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildPointerFile(), ILIAS\Language\ComponentTranslation\NativeGettext\isActive(), ILIAS\Language\ComponentTranslation\MigratedTranslations\missingBuildMessage(), ILIAS\Language\ComponentTranslation\MigratedTranslations\pointer(), ILIAS\Language\ComponentTranslation\ShippedTranslationsBuild\readPointer(), ILIAS\Language\ComponentTranslation\MigratedTranslations\reportNewerOtherBuild(), and ILIAS\Language\ComponentTranslation\ShippedTranslationsBuild\runLocked().

Here is the caller graph for this function:

◆ useSystemLocaleForTests()

static ILIAS\Language\ComponentTranslation\NativeGettext::useSystemLocaleForTests ( ?bool $system_locale )

static

Makes usesSystemLocale() return $system_locale (null: by PHP_OS_FAMILY again) - for tests only.

Definition at line 127 of file NativeGettext.php.

                                                                        : void
    {
        self::$system_locale_for_tests = $system_locale;
    }

Here is the caller graph for this function:

◆ useThreadSafeForTests()

static ILIAS\Language\ComponentTranslation\NativeGettext::useThreadSafeForTests ( ?bool $thread_safe )

static

Makes isThreadSafe() return $thread_safe (null: PHP_ZTS again) - for tests only.

Definition at line 111 of file NativeGettext.php.

                                                                    : void
    {
        self::$thread_safe_for_tests = $thread_safe;
    }

Referenced by ILIAS\Language\ComponentTranslation\NativeGettextTest\testReactivateIfLostRepairsAForeignResetInAThreadSafePhpToo(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testRestoreChangesNothingInAThreadSafePhp(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testRestoreChangesNothingInAThreadSafePhpInTheSystemLocaleBranch().

Here is the caller graph for this function:

Field Documentation

◆ $active_locale

string ILIAS\Language\ComponentTranslation\NativeGettext::$active_locale = null

staticprivate

What setlocale() returned in the last successful activate().

Definition at line 74 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\isActive().

◆ $locale_directory

string ILIAS\Language\ComponentTranslation\NativeGettext::$locale_directory = null

staticprivate

Definition at line 71 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activate(), ILIAS\Language\ComponentTranslation\NativeGettext\activated(), and ILIAS\Language\ComponentTranslation\NativeGettext\activateSystemLocale().

◆ $messages_set

bool ILIAS\Language\ComponentTranslation\NativeGettext::$messages_set = false

staticprivate

Definition at line 90 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\activated().

◆ $previous

array ILIAS\Language\ComponentTranslation\NativeGettext::$previous = null

staticprivate

Definition at line 82 of file NativeGettext.php.

◆ $problem

string ILIAS\Language\ComponentTranslation\NativeGettext::$problem = null

staticprivate

Definition at line 88 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettext\getProblem().

◆ $system_locale_for_tests

bool ILIAS\Language\ComponentTranslation\NativeGettext::$system_locale_for_tests = null

staticprivate

Definition at line 86 of file NativeGettext.php.

◆ $thread_safe_for_tests

bool ILIAS\Language\ComponentTranslation\NativeGettext::$thread_safe_for_tests = null

staticprivate

Definition at line 84 of file NativeGettext.php.

◆ CATALOG_DIRECTORY

const string ILIAS\Language\ComponentTranslation\NativeGettext::CATALOG_DIRECTORY = self::CATALOG_LANGUAGE . '/LC_MESSAGES'

Definition at line 64 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\buildMoFile(), ILIAS\Language\ComponentTranslation\MigratedLanguageFilePaths\overlayMoFile(), ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testAnOverlayWithASymbolicLinkAnywhereBelowTheOverlayRootIsNotServed(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testIsLoadedTellsAReadableCatalogOfOurOwnByItsHeader().

◆ CATALOG_LANGUAGE

const string ILIAS\Language\ComponentTranslation\NativeGettext::CATALOG_LANGUAGE = 'messages'

The value of LANGUAGE: the directory below a bound directory the catalogs are looked up in.

Definition at line 62 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\NativeGettextTest\testActivateKeepsARealLocaleAndRestoreLeavesItWhileTakingLanguageBack(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testActivateServesTheBuildAndRestoreGivesTheProcessStateBack(), ILIAS\Language\ComponentTranslation\NativeGettextTest\testSystemLocaleBranchTranslatesWithoutLocaleDirectoryAndLeavesLocpathAlone(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testTheOwnLocaleIsNeverTakenForARealOneAfterLanguageWasLost().

◆ CODESET

const string ILIAS\Language\ComponentTranslation\NativeGettext::CODESET = 'UTF-8'

private

Definition at line 66 of file NativeGettext.php.

◆ LOCALE_NAME

const string ILIAS\Language\ComponentTranslation\NativeGettext::LOCALE_NAME = 'ilias_messages'

Definition at line 54 of file NativeGettext.php.

◆ MAX_MESSAGE_LENGTH

const int ILIAS\Language\ComponentTranslation\NativeGettext::MAX_MESSAGE_LENGTH = 4096

private

Longer message ids are refused by PHP (ValueError), so they are never found.

Definition at line 69 of file NativeGettext.php.

◆ SYSTEM_LOCALE_OS_FAMILIES

const array ILIAS\Language\ComponentTranslation\NativeGettext::SYSTEM_LOCALE_OS_FAMILIES = ['Darwin', 'BSD']

private

Definition at line 59 of file NativeGettext.php.

◆ SYSTEM_LOCALES

const array ILIAS\Language\ComponentTranslation\NativeGettext::SYSTEM_LOCALES = ['en_US.UTF-8', 'en_US.utf8']

LC_MESSAGES candidates where the system locale is used, see usesSystemLocale().

Definition at line 57 of file NativeGettext.php.

Referenced by ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\requireSystemLocale(), ILIAS\Language\ComponentTranslation\NativeGettextTest\requireSystemLocale(), ILIAS\Language\ComponentTranslation\ShippedTranslationsBuildTest\requireSystemLocale(), ILIAS\Language\ComponentTranslation\MigratedTranslationsTest\testASystemLocaleBuildOnAnotherPlatformServesNothingAndTheProblemNamesTheCause(), and ILIAS\Language\ComponentTranslation\NativeGettextTest\testSystemLocaleIsOnlyActiveAfterActivateAndRestoreGivesTheProcessStateBack().

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

components/ILIAS/Language/src/ComponentTranslation/NativeGettext.php

Static Public Member Functions

Data Fields

Static Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Function Documentation

◆ activate()

◆ activated()

◆ activateSystemLocale()

◆ bind()

◆ canLookUp()

◆ getProblem()

◆ isActive()

◆ isExtensionLoaded()

◆ isLoaded()

◆ isThreadSafe()

◆ keptLocale()

◆ processState()

◆ reactivateIfLost()

◆ resetForTests()

◆ restore()

◆ translate()

◆ translatePlural()

◆ usesSystemLocale()

◆ useSystemLocaleForTests()

◆ useThreadSafeForTests()

Field Documentation

◆ $active_locale

◆ $locale_directory

◆ $messages_set

◆ $previous

◆ $problem

◆ $system_locale_for_tests

◆ $thread_safe_for_tests

◆ CATALOG_DIRECTORY

◆ CATALOG_LANGUAGE

◆ CODESET

◆ LOCALE_NAME

◆ MAX_MESSAGE_LENGTH

◆ SYSTEM_LOCALE_OS_FAMILIES

◆ SYSTEM_LOCALES