ILIAS\Language\ComponentTranslation\ShippedTranslations Class Reference

Compiles the messages of a migrated module into the .mo native gettext serves (see NativeGettext): the shipped state for the build (ShippedTranslationsBuild) and the overlay of local changes (MigratedLanguageFileSync), both via compileCatalog(). More...

Collaboration diagram for ILIAS\Language\ComponentTranslation\ShippedTranslations:

Public Member Functions
	__construct (private readonly TranslationMarkupPolicy $markup_policy=new TranslationMarkupPolicy())
	compile (string $shipped_po, string $module, ?callable $on_markup_violation=null, ?callable $on_invalid_plural_forms=null)
	The compiled catalog of $module in $shipped_po, with markers (see the class docblock). More...
	compileShippedCatalog (TranslationCatalog $shipped, string $module, ?callable $on_markup_violation=null, ?callable $on_invalid_plural_forms=null)

Static Public Member Functions
static	compileCatalog (TranslationCatalog $source, string $module, bool $mark_identity, ?\Closure $value_of=null, ?callable $on_invalid_plural_forms=null)
	The catalog native gettext serves for $module's messages in $source, see the class docblock. More...

Data Fields
const string	PLURAL_CONTEXT = 'ilias-plural'
const string	IDENTITY_CONTEXT = 'ilias-identity'

Private Member Functions
	sanitized (string $value, string $key, ?callable $on_markup_violation)
	$value cleaned by the markup policy, $on_markup_violation called for $key if anything was removed. More...

Detailed Description

Compiles the messages of a migrated module into the .mo native gettext serves (see NativeGettext): the shipped state for the build (ShippedTranslationsBuild) and the overlay of local changes (MigratedLanguageFileSync), both via compileCatalog().

Layout, so txt() needs one lookup per identifier:

• every message of the module (see MigratedLanguageFileSync::moduleEntries()) under its identifier WITHOUT context;
• a plural message additionally with every form under PLURAL_CONTEXT (dngettext() with "<context>\x04<identifier>"), while the entry without context holds its default form (PluralForms::defaultValueOf());
• with $mark_identity, "IDENTITY_CONTEXT\x04<identifier>" => "1" for every message whose value is its identifier: gettext answers a missing translation with the identifier, this tells "translated as itself" from "not translated" (see TranslationGettextRepository). The charset is always UTF-8; "Plural-Forms" is the rule PluralForms reads from the source (Germanic for a missing or invalid header), so gettext and PluralForms agree. Untranslated messages are left out, fuzzy ones compiled (see TranslationCatalog::toMoString()).

compile() is compileCatalog() of a shipped .po with every value cleaned by TranslationMarkupPolicy::sanitize().

Definition at line 47 of file ShippedTranslations.php.

Constructor & Destructor Documentation

__construct()

ILIAS\Language\ComponentTranslation\ShippedTranslations::__construct

(

private readonly TranslationMarkupPolicy

$markup_policy = new TranslationMarkupPolicy()

)

Definition at line 53 of file ShippedTranslations.php.

      {
    }

Member Function Documentation

compile()

ILIAS\Language\ComponentTranslation\ShippedTranslations::compile	(	string	$shipped_po,
		string	$module,
		?callable	$on_markup_violation = null,
		?callable	$on_invalid_plural_forms = null
	)

The compiled catalog of $module in $shipped_po, with markers (see the class docblock).

Parameters

(callable(string	$identifier, list<string> $violations): void)|null $on_markup_violation called for every cleaned value with what was removed (for a plural form with its form key, see PluralFormKey)
(callable(string	$message): void)|null $on_invalid_plural_forms called if there are plural messages but the "Plural-Forms" header is missing or invalid (the Germanic rule is used then)

Returns

array{mo: string, values: array<string, string>} the .mo and the value it serves for each identifier (see compileCatalog())

Exceptions

RuntimeException

if $shipped_po cannot be read, parsed or compiled

Definition at line 70 of file ShippedTranslations.php.

     : array {
        return $this->compileShippedCatalog(
            TranslationCatalog::fromPoFile($shipped_po),
            $module,
            $on_markup_violation,
            $on_invalid_plural_forms
        );
    }

compileCatalog()

static ILIAS\Language\ComponentTranslation\ShippedTranslations::compileCatalog ( TranslationCatalog  $source, string  $module, bool  $mark_identity, ?\Closure  $value_of = null, ?callable  $on_invalid_plural_forms = null  )

static

The catalog native gettext serves for $module's messages in $source, see the class docblock.

Deterministic: the same messages always compile to the same bytes.

Parameters

bool	$mark_identity	whether to add the markers of messages translated as their identifier
	(

Closure(string $value, string $key): string)|null $value_of what is compiled for a value (every form of a plural message with its form key, see PluralFormKey); default: the value itself

Parameters

(callable(string

$message): void)|null $on_invalid_plural_forms see compile()

Returns

array{mo: string, values: array<string, string>} the .mo and the value it serves for each identifier without context (for a plural message the value of its default form), in catalog order

Exceptions

RuntimeException

if the messages cannot be compiled (see TranslationCatalog::toMoString())

Definition at line 118 of file ShippedTranslations.php.

     : array {
        $catalog = new TranslationCatalog();
        foreach ($source->getHeaders() as $name => $value) {
            $catalog->setHeader($name, $value);
        }
        // never an empty header: TranslationGettextRepository tells a readable catalog by it, and the C
        // library takes the charset from it (TranslationCatalog only reads UTF-8)
        $catalog->setHeader('Content-Type', 'text/plain; charset=UTF-8');
 
        $plural_forms = null;
        $values = [];
        foreach (MigratedLanguageFileSync::moduleEntries($source, $module) as $identifier => $entry) {
            $identifier = (string) $identifier;
            if ($entry->isPlural()) {
                $forms = $entry->getPluralTranslations();
                foreach ($forms as $form => $form_value) {
                    $forms[$form] = $value_of === null ? $form_value : $value_of($form_value, PluralFormKey::of($identifier, $form));
                }
                if (implode('', $forms) === '') {
                    continue;
                }
                if ($plural_forms === null) {
                    $plural_forms = PluralForms::fromHeaderOrGermanic($source->getHeader('Plural-Forms'), $on_invalid_plural_forms);
                    $catalog->setHeader('Plural-Forms', $plural_forms->getHeader());
                }
                $plural = new TranslationEntry(self::PLURAL_CONTEXT, $identifier);
                $plural->setPlural((string) $entry->getPluralId(), $forms);
                $catalog->add($plural);
                $value = $plural_forms->defaultValueOf($forms);
            } else {
                $value = $value_of === null ? $entry->getTranslation() : $value_of($entry->getTranslation(), $identifier);
            }
            if ($value === '') {
                continue;
            }
 
            $singular = new TranslationEntry(null, $identifier);
            $singular->translate($value);
            $catalog->add($singular);
            $values[$identifier] = $value;
            if ($mark_identity && $value === $identifier) {
                $marker = new TranslationEntry(self::IDENTITY_CONTEXT, $identifier);
                $marker->translate('1');
                $catalog->add($marker);
            }
        }
 
        return ['mo' => $catalog->toMoString(), 'values' => $values];
    }

References ILIAS\Language\ComponentTranslation\Catalog\TranslationCatalog\setHeader().

Here is the call graph for this function:

compileShippedCatalog()

ILIAS\Language\ComponentTranslation\ShippedTranslations::compileShippedCatalog	(	TranslationCatalog	$shipped,
		string	$module,
		?callable	$on_markup_violation = null,
		?callable	$on_invalid_plural_forms = null
	)

Parameters

(callable(string	$identifier, list<string> $violations): void)|null $on_markup_violation see compile()
(callable(string	$message): void)|null $on_invalid_plural_forms see compile()

Returns

array{mo: string, values: array<string, string>} see compile()

Exceptions

RuntimeException

if the messages cannot be compiled

Definition at line 90 of file ShippedTranslations.php.

     : array {
        return self::compileCatalog(
            $shipped,
            $module,
            true,
            fn(string $value, string $key): string => $this->sanitized($value, $key, $on_markup_violation),
            $on_invalid_plural_forms
        );
    }

sanitized()

ILIAS\Language\ComponentTranslation\ShippedTranslations::sanitized ( string  $value, string  $key, ?callable  $on_markup_violation  )

private

$value cleaned by the markup policy, $on_markup_violation called for $key if anything was removed.

Parameters

(callable(string

$identifier, list<string> $violations): void)|null $on_markup_violation

Definition at line 179 of file ShippedTranslations.php.

                                                                                          : string
    {
        $violations = $this->markup_policy->findViolations($value);
        if ($violations === []) {
            return $value;
        }
        if ($on_markup_violation !== null) {
            $on_markup_violation($key, $violations);
        }
 
        return $this->markup_policy->sanitize($value);
    }

Field Documentation

IDENTITY_CONTEXT

const string ILIAS\Language\ComponentTranslation\ShippedTranslations::IDENTITY_CONTEXT = 'ilias-identity'

Definition at line 51 of file ShippedTranslations.php.

Referenced by ILIAS\Language\ComponentTranslation\TranslationGettextRepository\getText().

PLURAL_CONTEXT

const string ILIAS\Language\ComponentTranslation\ShippedTranslations::PLURAL_CONTEXT = 'ilias-plural'

Definition at line 49 of file ShippedTranslations.php.

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

---

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

• components/ILIAS/Language/src/ComponentTranslation/ShippedTranslations.php